Update workflow to support standard format CHANGELOG files
#1529
+7
−3
Conversation
This file contains 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
At the moment, the gem autorelease workflow only supports `CHANGELOG` fles that have version numbers with h1 level headings. Whilst this format is used in most GOV.UK gems, there are some that have been updated to use the more standard format with a single h1 and then h2 level headings for each version. This latter format meets accessibility standards by only having a single h1 on the page and appears to be a community standard [1]. Therefore updating the gem autorelease workflow to support both types of file. 1: https://keepachangelog.com/en/1.1.0/
yndajas
reviewed
Nov 25, 2024
| cat CHANGELOG.md >> NEW_CHANGELOG.md | ||
| mv NEW_CHANGELOG.md CHANGELOG.md | ||
| if [[ $(head -n1 CHANGELOG.md) == "# Changelog" ]]; then | ||
| sed -i "s/# Changelog/# Changelog\n\n## $next_ver\n\n* Update dependencies/" CHANGELOG.md |
There was a problem hiding this comment.
question: regex
Does the asterisk need escaping given this is regex?
There was a problem hiding this comment.
I don't believe it does if in the replacement part of the regex (after the second /).
|
@brucebolt Does this PR need a further review? |
Yes please |
MuriloDalRi
approved these changes
Dec 13, 2024
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.
At the moment, the gem autorelease workflow only supports
CHANGELOGfles that have version numbers with h1 level headings.Whilst this format is used in most GOV.UK gems, there are some that have been updated to use the more standard format with a single h1 and then h2 level headings for each version.
This latter format meets accessibility standards by only having a single h1 on the page and appears to be a community standard.
Therefore updating the gem autorelease workflow to support both types of file.