Skip to content

add note on versioning approach to changelog #2044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nickfyson merged 3 commits into from
Dec 18, 2023
Merged

add note on versioning approach to changelog #2044

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cda785e
add note on versioning approach to changelog
nickfyson Dec 18, 2023
8478e2a
clarify comment on versions in the changelog
nickfyson Dec 18, 2023
2603673
clarify comment on versions in the changelog
nickfyson Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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.
Note that the only difference between `v2` and `v3` of the CodeQL Action is the node version they support, with `v3` running on node 20 while we continue to release `v2` to support running on node 16. This approach ensures an easy way to track exactly which features are included in different versions, indicated by the minor and patch version numbers.
Copy link
Contributor

@aeisenberg aeisenberg Dec 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, but now it's missing something about 2.x.y and 3.x.y being the same except for node version. It was in the previous attempt and only implied here. 😄

Copy link
Contributor Author

@nickfyson nickfyson Dec 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have pushed another commit. Review comments containing suggested changes are more than welcome if I'm still not hitting the mark! 😆

Copy link
Contributor

@aeisenberg aeisenberg Dec 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry...reviewing on my phone (power outage), so crafting precise changes it hard.


## [UNRELEASED]

Expand Down