-
Notifications
You must be signed in to change notification settings - Fork 350
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update PR checks readme instructions
- Loading branch information
1 parent
c6454d5
commit 9323695
Showing
1 changed file
with
8 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,14 @@ | ||
# PR Checks | ||
|
||
This folder contains the code supporting the workflows run when a PR is created. | ||
This folder contains the workflow generator that must be run in order to create the | ||
workflows used by the CodeQL Action CI. Workflows must be recreated after any change | ||
to one of the files in this directory. | ||
|
||
## Update | ||
|
||
If you need to make a change to any of the PR checks, you need to perform the following | ||
steps: | ||
|
||
1. Make the change - the code for the PR checks is under the `pr-checks/checks/` folder. | ||
2. Run the `sync.py` file to produce (and sync) the final workflow files under `.github/` | ||
|
||
The second part requires some associated steps (create a virtual environment, download | ||
the dependencies for the Python script, etc), so we have automated this with the `justfile` | ||
included in this folder. | ||
|
||
### 1-step update | ||
## Updating workflows | ||
|
||
1. Install https://github.com/casey/just by whichever way you prefer. | ||
2. Run `$ just update-pr-checks` in your terminal. | ||
2. Run `just update-pr-checks` in your terminal. | ||
|
||
### If you don't want to intall `just` | ||
|
||
If you don't wish to install `just`, you can also manually perform the steps | ||
outlined in the `justfile` under the `update-pr-checks` action. | ||
Manually run each step in the `justfile`. |