From f186460b2b22fc18f060c30a3613a1157e6b53d4 Mon Sep 17 00:00:00 2001 From: JP Lomas <jp@theqrl.org> Date: Tue, 10 Sep 2024 10:29:44 +0100 Subject: [PATCH] CONTRIBUTING.md update Documents actionlint use as part of CI basic workflow including instructions of running locally. Signed-off-by: JP Lomas <jp@theqrl.org> --- CONTRIBUTING.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b87108e37f..a467d9c451 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,6 +56,20 @@ GitHub CI jobs. When executed in the main `liboqs` directory, When installing `act` as a GitHub extension, prefix the commands with `gh `. +## Modifications to CI + +Modifications to GitHub Actions workflows are checked with [actionlint](https://github.com/rhysd/actionlint) during the [basic.yml](.github/workflows/basic.yml) job, protecting the CI chain and against wrong approval decisions based on improper CI runs. Changes to these workflows can be validated locally with `actionlint`: + +```bash +actionlint .github/workflows/*.yml +``` + +or running the CI locally (as above): + +```bash +act workflow_call -W '.github/workflows/basic.yml' +``` + ### New features Any PR introducing a new feature is expected to contain a test of this feature @@ -70,6 +84,3 @@ add a tag to one or more of our [most active contributors](https://github.com/op If you feel like contributing but don't know what specific topic to work on, please check the [open issues tagged "good first issue" or "help wanted"](https://github.com/open-quantum-safe/liboqs/issues). - - -