http-client-python-bump-and-release
Create a PR to bump TypeSpec/Azure Tools dependencies, update peer dependencies, or release a new version of the http-client-python package.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 5.9k
- Forks
- 423
01 前言 Front Matter
- name
- http-client-python-bump-and-release
- description
- Create a PR to bump TypeSpec/Azure Tools dependencies, update peer dependencies, or release a new version of the http-client-python package.
03 SKILL.md 正文
HTTP Client Python Bump and Release
Create a PR to bump dependencies and release a new version of the http-client-python package.
Note:
{REPO}refers to the root folder of themicrosoft/typespecrepository.
Prerequisites
Before starting, verify that npm-check-updates is available:
npx --no-install npm-check-updates --version
If the command fails or prompts for installation, install it globally:
npm install -g npm-check-updates
The version script also requires pnpm and the repository's workspace dependencies, even though the emitter uses npm. Verify that pnpm --version and pnpm exec chronus --version work from {REPO}. If pnpm is missing, install the version declared in the root package.json's packageManager field. If Chronus is missing, run pnpm install --frozen-lockfile from {REPO} before continuing.
Use the CFS feed https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-js/npm/registry/ for dependency queries and installation. From the package directory, verify that npm config get registry reports this feed; it is configured in the package's .npmrc. Do not silently fall back to npmjs.org if the feed is unavailable.
Workflow
-
Navigate to the package directory:
cd {REPO}/packages/http-client-python -
Inspect the worktree and fetch main without discarding local changes:
git status --short git fetch origin mainPreserve unrelated local work. Do not run
git resetorgit checkout .as release preparation. -
Create release branch (use current date in MM-DD format):
git switch -c publish/python-release-{MM-DD} origin/main -
Update dependencies:
npx npm-check-updates -u --filter '@typespec/*,@azure-tools/*' --packageFile package.json --registry https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-js/npm/registry/ -
Update
peerDependenciesin package.json:- Do not assume step 4 updated peer dependencies: in the release run it updated development dependencies but left peer lower bounds unchanged. Use the latest versions reported in step 4 for the corresponding peers.
- If format is
">=0.a.b <1.0.0": Update only the0.a.bportion, keep the range format unchanged - If format is
"^1.a.b": Update to the latest version
-
Verify
devDependenciesversions for specs:- Check
@typespec/http-specsand@azure-tools/azure-http-specs - If the original version in
package.jsonis newer than the updated value, keep the original version - Dev versions are typically in the form
x.y.z-alpha.N-dev.M(e.g.,0.1.0-alpha.37-dev.3).
Example:
- Original:
@typespec/http-specs: 0.1.0-alpha.12-dev.5, updated by step 4 to0.1.0-alpha.11→ keep0.1.0-alpha.12-dev.5. - Original:
@typespec/http-specs: 0.1.0-alpha.12-dev.5, updated by step 4 to0.1.0-alpha.12→ keep0.1.0-alpha.12(step 4 works as expected). - Original:
@azure-tools/azure-http-specs: 0.1.0-alpha.12-dev.2, updated to0.1.0-alpha.11→ keep0.1.0-alpha.12-dev.2. - Original:
@azure-tools/azure-http-specs: 0.1.0-alpha.12-dev.2, updated to0.1.0-alpha.12→ keep0.1.0-alpha.12(step 4 works as expected).
- Check
-
Run version change script:
npm run change:versionVerify that the script updated both the emitter version in
package.jsonandCHANGELOG.md. If neither file was updated:-
Increment the third component of the emitter version in
package.json(for example,a.b.ctoa.b.(c+1)). -
Add this entry near the top of
CHANGELOG.md, immediately after the changelog title:## <new emitter version> ### Bump dependencies - Bump dependencies of `@typespec/*` and `@azure-tools/*` to latest versions
Verify that the version in
package.jsonmatches the newCHANGELOG.mdheading. Consumed Python change files under.chronus/changes/are expected deletions; include them in the release commit. -
-
Install, build, validate, and commit:
npm install --registry=https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-js/npm/registry/ && npm run build npm run lint npm run test:emitterRun formatting from
{REPO}using thepnpm-formatskill. Ifpackages/prettier-plugin-typespec/dist/index.jsis missing, build the formatter first withpnpm -r --filter '@typespec/prettier-plugin-typespec...' build, then runpnpm format. Do not repeat dependency installation or build the entire monorepo for this missing-plugin error.Verify that
package-lock.jsonand its root package entry match the manifest version, peer dependencies, and development dependencies. Reviewgit diff --checkand the changed-file list; stage only the release manifest, lockfile, changelog, and consumed Python change files. Commit using a conventional message such aschore(python): bump version to <version>and the required co-author trailer.Check the lockfile diff for registry changes: preserve existing CFS URLs and resolve new or updated packages through CFS, without migrating unrelated pre-existing npmjs.org entries. Changing the registry and rerunning
npm install --package-lock-onlydid not repair existing npmjs.org URLs in the release run. If correcting such a lockfile, obtain the exact CFS tarball URLs from feed metadata and verify their contents against the lockfile integrity hashes before replacing URLs; do not blindly rewrite hosts or change package versions. -
Push and create PR:
cd {REPO} git push origin HEAD -
Create PR with title
[python] release new versionand no description.Verify the created PR's title, description, base/head branches, and draft state rather than relying on the creation tool's output. The release run's PR tool inserted a placeholder despite receiving an empty body; if this happens, clear it with
gh api --method PATCH repos/microsoft/typespec/pulls/<number> -f body=''and verify again. If the tool creates a draft, mark it ready withgh pr ready <number>unless the user requested a draft.
Post-Process Review
- After the pull request is created, review the complete release run: commands executed, command output, manual interventions, validation results, changed files, commit, push, cleanup, and PR creation.
- Update this skill only when the completed run provides a concrete finding and a strong reason for the change, such as:
- A documented step failed or produced an incorrect result.
- The agent needed an undocumented manual correction to complete the release.
- A step was ambiguous enough to create a real risk or delay.
- A command was unnecessary or could be replaced by a demonstrably safer or more reliable command.
- Do not change the skill based on preference, speculation, or an unobserved edge case. For every update, record the observed evidence and explain why the edit improves future releases.
- Keep any skill update minimal, validate its formatting and frontmatter, and keep it separate from the completed release PR unless the user explicitly asks to include it there.
- If the review finds no evidence-backed improvement, leave the skill unchanged and state that no update was warranted.
- Return the branch name, prepared
@typespec/http-client-pythonversion, commit hash, pull request URL, review findings, and any skill update to the user. Creating a release PR does not mean the package has been published.
04 同仓库更多 Skills
test-unbranded-emitter
Build and test the @typespec/http-client-python emitter. Use this skill whenever the user wants to test their local changes to the emitter, run the generator test suite, check if their http-client-python changes are passing, or validate a fix. Triggers on phrases like "test the emitter", "run tests", "check if my changes pass", "run test:generator", "run CI", or any mention of testing/validating changes in the emitter package.
generate-from-typespec
Generate Python SDK code from a TypeSpec specification using the local emitter. Use this skill when the user wants to generate/regenerate a Python client from a TypeSpec spec, provides a GitHub URL or local path to a TypeSpec project, or says things like "generate from this spec", "emit Python from this tsp", "regenerate the SDK", or "compile this TypeSpec for Python".
diff-upstream
Regenerate the local emitter and diff the generated code against the upstream baseline checked into autorest.python. Use this skill when the user wants to see how their emitter changes affect generated code compared to what's currently in production, says things like "diff upstream", "compare to baseline", "what changed vs production", "show me the diff", "how does this affect generated code", or wants to validate their changes produce the expected output differences.
writing-python-sdk-spector-mock-api-tests
Writes TypeSpec http-client-python generator mock API tests (azure/unbranded/shared) from a Spector case. Use when given a Spector case link or a PR link that modifies Spector cases under http-specs/azure-http-specs.
pnpm-format
Format the codebase with pnpm and recover from common formatting failures.
minimal-repro
Help create a minimal reproduction for a TypeSpec compiler or emitter bug. Use when a user provides TypeSpec source (pasted code or a GitHub URL) and describes an issue. Reproduces locally and reduces to a single-file repro.