Automate changelog from release notes#153
Merged
Merged
Conversation
Props to @johnbillion for the work he had done on https://github.com/johnbillion/user-switching that this work is very minorly tweaked from. - The README.md contains a HTML comment as a placeholder. - During the deploy workflow (which happens when a non-pre-release release is made from a tag), it connects to the GitHub API, and pulls down previous release notes, removes any pre-release entries, sorts them into order, and loops through to create a string of headings and release notes. - This then replaces the HTML comment in the README.md file. Now instead of maintaining release notes in a CHANGELOG file or in the README, AND also in the GitHub release notes, it's now a single location (GitHub release notes). The `changelog.js` workflow script can also be called locally, and this will do a one-time replacement of the HTML comment (for testing or removal of this automation). It needs a GitHub personal access token, and then call: TOKEN=... GITHUB_REPOSITORY='Automattic/ad-code-manager' node .github/workflows/changelog.js
GaryJones
added
the
type: maintenance
|
@GaryJones I had planned on converting this into a standalone composite action so it's reusable across repos but haven't gotten around to it. So if you find yourself twiddling your thumbs... |
Collaborator
Author
|
@johnbillion I did wonder if that was on your radar. Would make sense to do that. Not something I've created before. |
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
2 participants
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.
Props to @johnbillion for the work he had done on https://github.com/johnbillion/user-switching that this work is very minorly tweaked from.
Now instead of maintaining release notes in a CHANGELOG file or in the README, AND also in the GitHub release notes, it's now a single location (GitHub release notes).
The
changelog.jsworkflow script can also be called locally, and this will do a one-time replacement of the HTML comment (for testing or removal of this automation). It needs a GitHub personal access token, and then call:TOKEN=... GITHUB_REPOSITORY='Automattic/ad-code-manager' node .github/workflows/changelog.js