Skip to content

Commit 2dbffae

Browse files
committed
add note in CONTRIBUTING.md on how to deprecate an action version
1 parent b7f289e commit 2dbffae

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,14 @@ We typically deprecate a version of CodeQL when the GitHub Enterprise Server (GH
101101

102102
## Deprecating a CodeQL-Action version (write access required)
103103

104-
TODO: fill this section in!
104+
When necessary we maintain multiple versions of the CodeQL action, for example to support older version of NodeJS as required by GHES versions that are still supported. The automated release process opens backport PRs to update older versions once the primary release is merged. Deprecation of older versions of the action will generally happen once a particular older GHES version is no longer supported, and hence we can stop maintainin the action for a particular NodeJS version.
105+
106+
The backport process is controlled by setting the minimum version number of the action that is still supported, defined at the in the [release-branches](.github/actions/release-branches/release-branches.py) action. To stop udpating an older version of the action:
107+
108+
1. Notify any users who are still pinned to the `vN` tag of the deprecated version of the action.
109+
- Add a changelog note announcing the deprecation.
110+
2. Bump the `OLDEST_SUPPORTED_MAJOR_VERSION` in [release-branches.py](.github/actions/release-branches/release-branches.py)
111+
3. Merge this change to main and the next release will not backport changes to the deprecated release version.
105112

106113
## Resources
107114

0 commit comments

Comments
 (0)