Skip to content

Commit cda785e

Browse files
committed
add note on versioning approach to changelog
1 parent 511f073 commit cda785e

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

.github/workflows/post-release-mergeback.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ jobs:
133133
# Update the version number ready for the next release
134134
npm version patch --no-git-tag-version
135135
136-
# Update the changelog
137-
perl -i -pe 's/^/## \[UNRELEASED\]\n\nNo user facing changes.\n\n/ if($.==5)' CHANGELOG.md
136+
# Update the changelog, adding a new version heading directly above the most recent existing one
137+
awk '!f && /##/{print "'"## [UNRELEASED]\n\nNo user facing changes.\n"'"; f=1}1' CHANGELOG.md > temp && mv temp CHANGELOG.md
138138
git add .
139139
git commit -m "Update changelog and version after ${VERSION}"
140140

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
See the [releases page](https://github.com/github/codeql-action/releases) for the relevant changes to the CodeQL CLI and language packs.
44

5+
Note that for the CodeQL Action we use the major version number to mark a change in the node version used, while the minor & patch numbers indicate releases that support the same features across node versions. For example `3.22.11` is the first `v3` release and is functionally identical to `2.22.11`, which was released while we continue to support `v2`. This approach ensures an easy way to track exactly which features are included in different versions.
6+
57
## [UNRELEASED]
68

79
No user facing changes.

0 commit comments

Comments
 (0)