docs: add RELEASING.md#20
Draft
MikeGoldsmith wants to merge 3 commits into
Draft
Conversation
Documents the per-package independent release model used by this repo, the manual end-to-end release steps with the existing build scripts, and the towncrier-based changelog flow. Calls out missing pieces explicitly: PyPI names are still TBD per package, and contrib's automated release workflows haven't been ported yet. Both tracked in the bootstrap issue. Assisted-by: Claude Opus 4.7 (1M context)
There was a problem hiding this comment.
Pull request overview
Adds release-process documentation for the repository’s independent per-package release model, including manual release steps while automated release workflows are still pending.
Changes:
- Adds
RELEASING.mdwith publishable package list and release flow. - Documents changelog, version bump, tagging/building, PyPI upload, GitHub release, and next-dev-version steps.
- Captures missing release infrastructure tracked by #15.
Comments suppressed due to low confidence (3)
RELEASING.md:98
- The release-notes extraction command does not extract the release body. In awk range patterns, the end pattern
^##also matches the starting## Version <version>line, so the range ends on the same line andsed '$d'removes the only line. Maintainers following this command would create a GitHub release with empty notes.
--notes-file <(awk '/^## Version <version>/,/^## /{print}' <package>/CHANGELOG.md | sed '$d')
RELEASING.md:76
- This uses
<pypi-name>asPACKAGE_NAME, butscripts/build_a_package.shusesPACKAGE_NAMEto locate**/$pkg_name/pyproject.toml. The document also says the PyPI names will differ from the current package directories, so the documented command will fail unless the directory/project name matches the PyPI name or the build script is updated.
PACKAGE_NAME=<pypi-name> VERSION=<version> ./scripts/build_a_package.sh
RELEASING.md:120
- The stated unstable version pattern does not match several current package versions (for example, anthropic/langchain/weaviate use
2.0b0.dev, google-genai uses2.5b0.dev, and openai-agents-v2 uses0.2.0.dev). Following this section as written could cause maintainers to bump releases to the wrong version scheme.
- **Unstable components** (everything currently in this repo): versions look
like `0.Yb0.dev` on `main`, `0.Yb0` at release time, then bump to
`0.{Y+1}b0.dev`.
Addresses Copilot review feedback: the changelog steps depend on open-telemetry#16 (towncrier setup) which hasn't merged yet. Make the dependency explicit at the top of the doc so it's obvious to any reviewer. Assisted-by: Claude Opus 4.7 (1M context)
The note belongs in the PR description as a merge-ordering signal, not in the doc itself where it would have to be removed once open-telemetry#16 lands. Assisted-by: Claude Opus 4.7 (1M context)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
RELEASING.mdcovering the per-package release model this repo uses.Contents:
CHANGELOG.md, and cadence.scripts/build_a_package.sh,twine upload, GitHub release, bump to next dev version.## Unreleasedentries that pre-date towncrier and need manual folding on the first release.prepare-release/package-releaseworkflows, backport workflow, patch-release tooling. All tracked in Bootstrap opentelemetry-python-genai repo #15.Merge ordering
Important
Depends on #16 (towncrier setup). The changelog steps in this document reference
towncrier, which is added to the dev dependencies and configured per package in #16. Do not merge this PR until #16 lands. Kept as a draft for that reason.Notes
Skip Changeloglabel applied (docs-only).