Skip to content

Commit 9323695

Browse files
aeisenbergNlightNFotis
authored andcommitted
Update PR checks readme instructions
1 parent c6454d5 commit 9323695

File tree

1 file changed

+8
-17
lines changed

1 file changed

+8
-17
lines changed

pr-checks/readme.md

+8-17
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,14 @@
11
# PR Checks
22

3-
This folder contains the code supporting the workflows run when a PR is created.
3+
This folder contains the workflow generator that must be run in order to create the
4+
workflows used by the CodeQL Action CI. Workflows must be recreated after any change
5+
to one of the files in this directory.
46

5-
## Update
6-
7-
If you need to make a change to any of the PR checks, you need to perform the following
8-
steps:
9-
10-
1. Make the change - the code for the PR checks is under the `pr-checks/checks/` folder.
11-
2. Run the `sync.py` file to produce (and sync) the final workflow files under `.github/`
12-
13-
The second part requires some associated steps (create a virtual environment, download
14-
the dependencies for the Python script, etc), so we have automated this with the `justfile`
15-
included in this folder.
16-
17-
### 1-step update
7+
## Updating workflows
188

199
1. Install https://github.com/casey/just by whichever way you prefer.
20-
2. Run `$ just update-pr-checks` in your terminal.
10+
2. Run `just update-pr-checks` in your terminal.
11+
12+
### If you don't want to intall `just`
2113

22-
If you don't wish to install `just`, you can also manually perform the steps
23-
outlined in the `justfile` under the `update-pr-checks` action.
14+
Manually run each step in the `justfile`.

0 commit comments

Comments
 (0)