Skip to content

Commit 111428c

Browse files
committed
Add some instructions on how to regenerate required checks
1 parent d2fd19b commit 111428c

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Here are a few things you can do that will increase the likelihood of your pull
6363
1. The first step of releasing a new version of the `codeql-action` is running the "Update release branch" workflow.
6464
This workflow goes through the pull requests that have been merged to `main` since the last release, creates a changelog, then opens a pull request to merge the changes since the last release into the `v1` release branch.
6565

66-
A release is automatically started every Monday via a scheduled run of this workflow, however you can start a release manually by triggering a run via [workflow dispatch](https://github.com/github/codeql-action/actions/workflows/update-release-branch.yml).
66+
A release is automatically started every Monday via a scheduled run of this workflow, however you can start a release manually by triggering a run via [workflow dispatch](https://github.com/github/codeql-action/actions/workflows/update-release-branch.yml).
6767
1. The workflow run will open a pull request titled "Merge main into v1". Mark the pull request as [ready for review](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review) to trigger the PR checks.
6868
1. Review the checklist items in the pull request description.
6969
Once you've checked off all but the last of these, approve the PR and automerge it.
@@ -72,6 +72,26 @@ Here are a few things you can do that will increase the likelihood of your pull
7272

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

75+
## Keeping the PR checks up to date (requires admin access)
76+
77+
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.
78+
79+
To regenerate the PR jobs for the action:
80+
81+
1. From a terminal, run the following commands (replace `SHA` with the sha of the commit whose checks you want to use, typically this should be the latest from `main`):
82+
83+
```sh
84+
SHA= ####
85+
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)]')"
86+
CHECKS="$(echo $CHECKS | sed -E 's|\].*\[|,|g')" # Because the gh command is paginated, the results are multiple arrays
87+
echo "{\"contexts\": ${CHECKS}}" > checks.json
88+
gh api -X "PATCH" repos/github/codeql-action/branches/main/protection/required_status_checks --input checks.json
89+
gh api -X "PATCH" repos/github/codeql-action/branches/v1/protection/required_status_checks --input checks.json
90+
````
91+
92+
2. Go to the [branch protection rules settings page](https://github.com/github/codeql-action/settings/branches) and validate that the rules have been updated.
93+
94+
7595
## Resources
7696

7797
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)

0 commit comments

Comments
 (0)