Skip to content

Add a command to take a prepared provider back out of a release - #71836

Open
potiuk wants to merge 2 commits into
apache:mainfrom
potiuk:doc-only-release-flow
Open

Add a command to take a prepared provider back out of a release#71836
potiuk wants to merge 2 commits into
apache:mainfrom
potiuk:doc-only-release-flow

Conversation

@potiuk

@potiuk potiuk commented Aug 19, 2026

Copy link
Copy Markdown
Member

When review concludes that an already-prepared provider has no user-facing changes, correcting its
changelog entry is not enough: the version bump and the changelog section stay behind, so the provider
is still built and uploaded to PyPI. Undoing that by hand is a restore → re-run → answer-N sequence
that release managers repeatedly get wrong, and the sequence was documented nowhere outside the breeze
sources.

It is also unreachable during an incremental update. --incremental-update calls
set_forced_answer("yes"), which makes user_confirm answer every prompt with yes — including
Do you want to leave the version for X as is?, the gate behind the existing reclassify-to-doc-only
path. So at the point in the release where this decision is actually made, it could not be applied at all.

This adds a single command for it:

breeze release-management prepare-provider-documentation --mark-doc-only PROVIDER [MORE PROVIDERS]

It restores the provider's provider.yaml and changelog.rst to their released state and records
docs/.latest-doc-only-change.txt for you to commit. It reuses the existing doc-only marking path, so
these providers appear in the usual doc-only summary bucket. It requires an explicit provider list —
it takes providers out of a release, so defaulting to all of them would be the wrong failure mode —
and it refuses to write an empty marker when there is nothing to mark, since a bad marker would
silence that provider's next release too.

Documentation is added for both flows: the release guide gains a section explaining the difference
between a doc-only changelog entry (package still ships) and the marker file (no PyPI artifact at
all), and the prepare-providers-documentation skill gains the matching case in its pre-merge sweep —
which until now only looked for providers missing from a wave, never for providers that should no
longer be in one.

Raised on devlist Slack by the provider release managers.


Was generative AI tooling used to co-author this PR?
  • Yes — Claude Code (Opus 5)

Generated-by: Claude Code (Opus 5) following the guidelines

potiuk added 2 commits August 19, 2026 14:16
Release managers hit this when review concludes a prepared provider's changes
are internal after all: the changelog entry can be corrected, but the version
bump and changelog section stay behind and the provider is still built and
uploaded. The sequence that actually removes it from the wave - and the marker
file that records it - was described nowhere outside the breeze sources.

The pre-merge sweep only ever looked for providers missing from a wave, so the
opposite direction had nothing watching it in either the manual or the agentic
flow.
When review concludes that an already-prepared provider has no user-facing
changes, correcting its changelog entry leaves the version bump and the
changelog section behind, so the provider is still built and uploaded. Undoing
that by hand is a restore-rerun-answer-N sequence that release managers
repeatedly get wrong, and it is unavailable during an incremental update at all:
that mode answers every question with yes, so the prompt that reclassifies a
provider as doc-only never appears.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant