From a89fbc80a21d76b6e2304d8ccf53ae01036b94ab Mon Sep 17 00:00:00 2001 From: "Fotis Koutoulakis (@NlightNFotis)" Date: Mon, 9 Dec 2024 11:51:51 +0000 Subject: [PATCH] docs: add readme for justfile/pr-checks update --- pr-checks/readme.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 pr-checks/readme.md diff --git a/pr-checks/readme.md b/pr-checks/readme.md new file mode 100644 index 000000000..c53aa7f2b --- /dev/null +++ b/pr-checks/readme.md @@ -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.