-
Notifications
You must be signed in to change notification settings - Fork 333
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add readme for justfile/pr-checks update
- Loading branch information
1 parent
182c5e7
commit a89fbc8
Showing
1 changed file
with
23 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# PR Checks | ||
|
||
This folder contains the code supporting the workflows run when a PR is created. | ||
|
||
## 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 | ||
|
||
1. Install https://github.com/casey/just by whichever way you prefer. | ||
2. Run `$ just update-pr-checks` in your terminal. | ||
|
||
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. |