History

Fotis Koutoulakis (@NlightNFotis) a89fbc80a2 docs: add readme for justfile/pr-checks update		2024-12-09 11:51:51 +00:00
..
checks	ci: add capability to handle container initialisation steps to sync.py	2024-12-05 15:32:36 +00:00
justfile	ci: remove patch file and cleanup justfile	2024-12-05 15:56:48 +00:00
readme.md	docs: add readme for justfile/pr-checks update	2024-12-09 11:51:51 +00:00
sync.py	ci: add capability to handle container initialisation steps to sync.py	2024-12-05 15:32:36 +00:00

readme.md

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:

Make the change - the code for the PR checks is under the pr-checks/checks/ folder.
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

Install https://github.com/casey/just by whichever way you prefer.
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.