Skip to content

Commit 4ea06e9

Browse files
authored
Merge pull request #3499 from github/sam-robson/document-version-pinning-risk
docs: guidance on keeping the CodeQL Action up to date
2 parents 710e294 + c9223eb commit 4ea06e9

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,13 @@ We typically release new minor versions of the CodeQL Action and Bundle when a n
8080

8181
See the full list of GHES release and deprecation dates at [GitHub Enterprise Server releases](https://docs.github.com/en/enterprise-server/admin/all-releases#releases-of-github-enterprise-server).
8282

83+
## Keeping the CodeQL Action up to date
84+
85+
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.
86+
87+
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.
88+
89+
8390
## Troubleshooting
8491

8592
Read about [troubleshooting code scanning](https://docs.github.com/en/code-security/code-scanning/troubleshooting-code-scanning).

0 commit comments

Comments
 (0)