Skip to content

Add some instructions on how to regenerate required checks #968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aeisenberg merged 6 commits into from
Mar 11, 2022
Merged

Add some instructions on how to regenerate required checks #968

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
111428c
Add some instructions on how to regenerate required checks
aeisenberg Mar 8, 2022
04d521d
Avoid using `sed`, use `--slurp` instead
aeisenberg Mar 9, 2022
4e2634f
Merge branch 'main' into aeisenberg/required-checks
aeisenberg Mar 10, 2022
8ecc1fc
Ignore "Update Supported Enterprise Server Versions"
aeisenberg Mar 11, 2022
e64a215
Add name to workflow
aeisenberg Mar 11, 2022
560edbc
Merge branch 'main' into aeisenberg/required-checks
henrymercer Mar 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Avoid using sed, use --slurp instead
  • Loading branch information
@aeisenberg
aeisenberg committed Mar 9, 2022
commit 04d521d70560142c41136dc702bf028e2a88b5e3
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Here are a few things you can do that will increase the likelihood of your pull

Approve the mergeback PR and automerge it. Once the mergeback has been merged into main, the release is complete.

## Keeping the PR checks up to date (requires admin access)
## 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. Managing these PR checks manually is time consuming and complex. Here is a semi-automated approach.

Expand All @@ -82,8 +82,7 @@ To regenerate the PR jobs for the action:

```sh
SHA= ####
CHECKS="$(gh api repos/github/codeql-action/commits/${SHA}/check-runs --paginate | jq --compact-output --raw-output '[.["check_runs"] | .[].name | select(contains("https://") or . == "CodeQL" or . == "LGTM.com" or . == "Update dependencies" | not)]')"
CHECKS="$(echo $CHECKS | sed -E 's|\].*\[|,|g')" # Because the gh command is paginated, the results are multiple arrays
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" | not)]')"
Comment thread
aeisenberg marked this conversation as resolved.
Outdated
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/v1/protection/required_status_checks --input checks.json
Expand Down