Skip to content

Commit

Permalink
docs: add readme for justfile/pr-checks update
Browse files Browse the repository at this point in the history
  • Loading branch information
NlightNFotis committed Dec 9, 2024
1 parent 182c5e7 commit a89fbc8
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions pr-checks/readme.md
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.

0 comments on commit a89fbc8

Please sign in to comment.