From 72f823337ad32cd84721647f71902aa3654b88eb Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Thu, 28 May 2026 15:17:34 -0400 Subject: [PATCH] docs: add release process to Python emitter CONTRIBUTING.md Document the release workflow: version bump with chronus, publish/ branch naming convention, and auto-publish on merge. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- packages/http-client-python/CONTRIBUTING.md | 35 +++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/packages/http-client-python/CONTRIBUTING.md b/packages/http-client-python/CONTRIBUTING.md index 66d913fe4ff..608d22b32e7 100644 --- a/packages/http-client-python/CONTRIBUTING.md +++ b/packages/http-client-python/CONTRIBUTING.md @@ -9,6 +9,7 @@ Welcome! This guide will help you set up your development environment and contri - [Development Workflow](#development-workflow) - [Creating Pull Requests](#creating-pull-requests) - [Downstream Testing](#downstream-testing) +- [Release Process](#release-process) ## Prerequisites @@ -158,6 +159,40 @@ Once a new version of the branded emitter (`@azure-tools/typespec-python`) is re - `azure/` — Tests generated with the branded emitter (Azure SDK specs) - `unbranded/` — Tests generated with the unbranded emitter (TypeSpec HTTP specs) +## Release Process + +The release process for `@typespec/http-client-python` follows these steps: + +### 1. Version Bump + +From the root of the TypeSpec repository, run: + +```bash +pnpm chronus version --only @typespec/http-client-python --ignore-policies +``` + +This consumes all pending change files under `.chronus/changes/` for this package and bumps the version in `package.json` accordingly. + +### 2. Create a Release PR + +Create a branch from the version bump commit and open a PR to `main`: + +```bash +git checkout -b publish/python-release- +git push origin publish/python-release- +``` + +> **Note:** The branch **must** use the `publish/` prefix. This tells CI to skip certain checks (consistency, external-integration) and enables auto-publish on merge. + +### 3. Merge and Publish + +Once the release PR is reviewed and merged to `main`, the CI publish pipeline automatically: + +1. Builds the package with the new version +2. Publishes the npm tarball to the public npm registry + +No manual publish step is needed — merging the `publish/` branch triggers the release. + ## Getting Help - **Issues**: Report bugs or request features in the [TypeSpec repository issues](https://github.com/microsoft/typespec/issues)