From 9ed5fc7131494b125e49f3dae119ef679e0caca4 Mon Sep 17 00:00:00 2001 From: nickfyson Date: Wed, 20 Dec 2023 20:00:52 +0000 Subject: [PATCH] add note about backporting check changes to v2 branch --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d2703dee1..ea4ac72adb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,7 +76,9 @@ Since the `codeql-action` runs most of its testing through individual Actions wo 1. By default, this script retrieves the checks from the latest SHA on `main`, so make sure that your `main` branch is up to date. 2. Run the script. If there's a reason to, you can pass in a different SHA as a CLI argument. -3. After running, go to the [branch protection rules settings page](https://github.com/github/codeql-action/settings/branches) and validate that the rules for `main`, `v1`, and `v2` have been updated. +3. After running, go to the [branch protection rules settings page](https://github.com/github/codeql-action/settings/branches) and validate that the rules for `main`, `v2`, and `v3` have been updated. + +Note that any updates to checks need to be backported to the `releases/v2` branch, in order to maintain the same set of names for required checks. ## Deprecating a CodeQL version (write access required)