From d468c94a6969e696639d7e1295aba3f282dceb0a Mon Sep 17 00:00:00 2001 From: Andrew Eisenberg Date: Tue, 10 May 2022 09:55:27 -0700 Subject: [PATCH] Update contributing.md Change the text for keeping the checks up to date. --- CONTRIBUTING.md | 20 ++++---------------- 1 file changed, 4 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3b61e305de..3acb95b5f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,23 +80,11 @@ Here are a few things you can do that will increase the likelihood of your pull ## Keeping the PR checks up to date (admin access required) -Since the `codeql-action` runs most of its testing through individual Actions workflows, there are over two hundred jobs that need to pass in order for a PR to turn green. You can regenerate the checks automatically by running the [Update required checks](.github/workflows/update-required-checks.yml) workflow. +Since the `codeql-action` runs most of its testing through individual Actions workflows, there are over two hundred jobs that need to pass in order for a PR to turn green. You can regenerate the checks automatically by running the [update-required-checks.sh](.github/workflows/script/update-required-checks.sh) script: -Or you can use this semi-automated approach: - -1. In a terminal check out the `SHA` whose checks you want to use as the base. Typically, this will be `main`. -2. From a terminal, run the following commands: - - ```sh - SHA="$(git rev-parse HEAD)" - CHECKS="$(gh api repos/github/codeql-action/commits/${SHA}/check-runs --paginate | jq --slurp --compact-output --raw-output '[.[].check_runs | .[].name | select(contains("https://") or . == "CodeQL" or . == "LGTM.com" or . == "Update dependencies" or . == "Update Supported Enterprise Server Versions" | not)]')" - echo "{\"contexts\": ${CHECKS}}" > checks.json - gh api -X "PATCH" repos/github/codeql-action/branches/main/protection/required_status_checks --input checks.json - gh api -X "PATCH" repos/github/codeql-action/branches/releases/v2/protection/required_status_checks --input checks.json - gh api -X "PATCH" repos/github/codeql-action/branches/releases/v1/protection/required_status_checks --input checks.json - ```` - -3. Go to the [branch protection rules settings page](https://github.com/github/codeql-action/settings/branches) and validate that the rules have been updated. +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. ## Resources