robojerk/codeql-action

Update PR checks readme instructions

Browse source
This commit is contained in:
Andrew Eisenberg 2024-12-09 15:11:57 -08:00 • committed by Fotis Koutoulakis (@NlightNFotis)
parent c6454d58c8
commit 932369573c
1 changed files with 8 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

25
pr-checks/readme.md
View file

@ -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 wish to install `just`, you can also manually perform the steps
outlined in the `justfile` under the `update-pr-checks` action.
### If you don't want to intall `just`
Manually run each step in the `justfile`.