Skip to content

docs: document public API check workaround for patch releases #5867

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
mkoltsov wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: document public API check workaround for patch releases #5867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7de4c0a
docs: document public API check workaround for patch releases
mkoltsov Oct 31, 2026
9c78c09
ci: retrigger checks for #5867
mkoltsov Oct 31, 2026
c559a20
docs: add changelog fragment for release guidance
mkoltsov Oct 31, 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
1 change: 1 addition & 0 deletions .changelog/5867.changed
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs: document the public API check workaround for patch releases
13 changes: 13 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,19 @@ As a result, when preparing a release branch that contains a different set of in

* Optionally update the contrib.yml workflow to point to the corresponding release branch before running CI.

### Note on `public-symbols-check` for patch releases

The `public-symbols-check` job compares public symbols against `main`, not the
target release branch. Differences between `main` and the release branch can
therefore cause this check to fail even when the patch does not change the public
API.

Review the reported changes against the pull request's target release branch. If
the failure is caused by existing differences between branches, ask a maintainer
to add the `Approve Public API check` label to skip the job. Close and reopen the
pull request after the label is added so CI takes it into account. Public API
changes introduced by the patch still require the usual review.

## Making the release

* Run the [Release workflow](https://github.com/open-telemetry/opentelemetry-python/actions/workflows/release.yml).
Expand Down