Skip to content

docs: correct the release workflow description in the README #1232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MohammedAlkindi wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: correct the release workflow description in the README #1232

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0320ea
docs: correct the release workflow description in the README
MohammedAlkindi Aug 24, 2026
29d3cd8
Merge branch 'main' into docs/readme-release-workflow
MohammedAlkindi Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 6 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,27 +338,20 @@ See `python scripts/build_wheel.py --help` for all options.

### Release Workflow

The package is published to PyPI via the GitHub Actions workflow in `.github/workflows/publish.yml`. To create a new release:
The package is published to PyPI by the reusable `.github/workflows/build-and-publish.yml` workflow, called either automatically on a CLI version bump or manually from `.github/workflows/publish.yml`. To cut a release manually:

1. **Trigger the workflow** manually from the Actions tab with two inputs:
1. **Trigger the workflow** manually from the Actions tab with one input:
- `version`: The package version to publish (e.g., `0.1.5`)
- `claude_code_version`: The Claude Code CLI version to bundle (e.g., `2.0.0` or `latest`)

2. **The workflow will**:
- Build platform-specific wheels for macOS, Linux, and Windows
- Bundle the specified Claude Code CLI version in each wheel
- Bundle the pinned Claude Code CLI version in each wheel
- Build a source distribution
- Publish all artifacts to PyPI
- Create a release branch with version updates
- Open a PR to main with:
- Updated `pyproject.toml` version
- Updated `src/claude_agent_sdk/_version.py`
- Updated `src/claude_agent_sdk/_cli_version.py` with bundled CLI version
- Auto-generated `CHANGELOG.md` entry
- Commit the version bump (`pyproject.toml`, `src/claude_agent_sdk/_version.py`), add a Claude-generated `CHANGELOG.md` entry in a second commit, and push both directly to `main`
- Create a `v<version>` tag and a GitHub Release

3. **Review and merge** the release PR to update main with the new version information

The workflow tracks both the package version and the bundled CLI version separately, allowing you to release a new package version with an updated CLI without code changes.
The bundled CLI version is not a workflow input. It is pinned in `src/claude_agent_sdk/_cli_version.py`, which `scripts/build_wheel.py` reads at build time; bumping it on `main` with a `chore: bump bundled CLI version to X.Y.Z` commit cuts a patch release automatically once the Test workflow passes. See [RELEASING.md](RELEASING.md) for both release paths in full.

## License and terms

Expand Down