docs: guidance on keeping the CodeQL Action up to date#3499
Merged
sam-robson merged 2 commits intomainfrom Feb 23, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation to the README about keeping the CodeQL Action up to date. The new section provides guidance on version pinning strategies and warns about potential functionality loss when using pinned versions with server-side feature flag changes.
Changes:
- Added a new "Keeping the CodeQL Action up to date" section to README.md
- Documented the recommendation to use major version tags (e.g.,
v3) for automatic updates - Added guidance for users who pin to specific commit SHAs or patch versions
- Explained that server-side feature flags may be removed over time, affecting pinned versions
mbg
reviewed
Feb 23, 2026
|
|
||
| ## Keeping the CodeQL Action up to date | ||
|
|
||
| We recommend referencing the CodeQL Action using a major version tag (e.g. `v3`) in your workflow file. This ensures your workflow automatically picks up the latest release within that major version, including bug fixes, new features, and updated CodeQL CLI versions. |
|
|
||
| If you pin to a specific commit SHA or patch version tag, ensure you keep it updated (e.g. via [Dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot)). Some CodeQL Action features are controlled by server-side flags that may be removed over time, which can cause pinned versions to lose functionality. | ||
|
|
||
|
|
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
3 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.
Summary