docs(release-notes): editorial style guide for changelog sync (draft) - #788
Draft
jedigalt wants to merge 1 commit into
Draft
docs(release-notes): editorial style guide for changelog sync (draft)#788jedigalt wants to merge 1 commit into
jedigalt wants to merge 1 commit into
Conversation
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
1 participant
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.
Editorial pass for release-notes sync
Adds an automated editorial step to the changelog sync so the generated release-notes PR arrives
already shaped for a product audience — related entries consolidated and rewritten for clarity in the
existing page style — instead of raw commit lines. The review and publish flow is unchanged: a
maintainer still reviews and merges the PR as today.
The step runs behind
continue-on-error, so if it is skipped for any reason the existing PR opensexactly as before. No changes to the platform release pipeline.
In this PR
.github/release-notes-instructions.md— the editorial style guide the pass follows.Enabling it
A one-time workflow step and an Actions token are required to turn the pass on; these are handled
separately by a maintainer. Until then, sync behaves exactly as it does today.
Draft — not for merge until the enabling step is in place and validated.