Conversation
This comment was marked as off-topic.
This comment was marked as off-topic.
Member
Frontend previewsLast deployed commit is 1c2f9a1be44c40f05ae9a7770391c05268375c49
|
Closed
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.
We really suck at changelogs - we should be documenting everything we do - this will encourage it.
How it works
1. PR is opened
A GitHub Actions workflow (
changelog-comment.yml) posts a comment with a Keep a Changelog template. Each product area (App, Website, Hosting) gets its own collapsible<details>section, so a single PR can document different changes for different products.If the PR targets another PR's branch (child PR), the bot adds an admonition linking to the parent PR.
2. Author fills in the comment
The author edits the bot comment, expanding the relevant product sections and writing bullet points under the standard headings (Added, Changed, Deprecated, Removed, Fixed, Security). Empty sections and products are ignored.
3. Collecting changelogs
Before deploying
main→prod, run:The script:
mainsince the lastprodcommitkeep-a-changelog#issuereferences to GitHubpackages/blog/changelog.ts- can edit before committing to main to polish/QAUses
GITHUB_TOKENenv var, or falls back togh auth token.