diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2499c86ad..e3cba40ca 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,7 +7,7 @@ * [ ] Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)? (If so, a version bump will be required from *x.y.z* to *x.(y+1).0*.) -* [ ] Does this PR change the list of algorithms available -- either adding, removing, or renaming? Does this PR otherwise change an API? (If so, PRs in fully supported downstream projects dependent on these, i.e., [oqs-provider](https://github.com/open-quantum-safe/oqs-provider) will also need to be ready for review and merge by the time this is merged.) +* [ ] Does this PR change the list of algorithms available -- either adding, removing, or renaming? Does this PR otherwise change an API? (If so, PRs in fully supported downstream projects dependent on these, i.e., [oqs-provider](https://github.com/open-quantum-safe/oqs-provider) will also need to be ready for review and merge by the time this is merged. Also, make sure to update the list of algorithms in the continuous benchmarking files: .github/workflows/kem-bench.yml and sig-bench.yml) diff --git a/.github/workflows/commit-to-main.yml b/.github/workflows/commit-to-main.yml index 65e494d82..4068fec2f 100644 --- a/.github/workflows/commit-to-main.yml +++ b/.github/workflows/commit-to-main.yml @@ -26,14 +26,4 @@ jobs: basic-downstream: uses: ./.github/workflows/downstream-basic.yml - secrets: inherit - - call-kem-benchmarking: - uses: ./.github/workflows/kem-bench.yml - permissions: - contents: write - - call-sig-benchmarking: - uses: ./.github/workflows/sig-bench.yml - permissions: - contents: write + secrets: inherit \ No newline at end of file diff --git a/.github/workflows/weekly.yml b/.github/workflows/weekly.yml index d04bf101b..1d6a5993b 100644 --- a/.github/workflows/weekly.yml +++ b/.github/workflows/weekly.yml @@ -21,3 +21,13 @@ jobs: extended-tests: uses: ./.github/workflows/extended.yml + + kem-continuous-benchmarking: + uses: ./.github/workflows/kem-bench.yml + permissions: + contents: write + + sig-continuous-benchmarking: + uses: ./.github/workflows/sig-bench.yml + permissions: + contents: write \ No newline at end of file diff --git a/CI.md b/CI.md index ac21ed1b3..5d1052132 100644 --- a/CI.md +++ b/CI.md @@ -36,7 +36,7 @@ It calls [platform tests](#platforms.yml), [code coverage tests](#code-coverage. #### Weekly workflow (`weekly.yml`) This workflow is triggered by a weekly schedule. -It calls [extended tests](#extended.yml) and [scorecard analysis](#scorecard.yml). +It calls [extended tests](#extended.yml), [scorecard analysis](#scorecard.yml), and [continuous benchmarking](#kem-bench.yml-sig-bench.yml) #### Release workflow (`release.yml`) @@ -105,6 +105,11 @@ This workflow runs the [OpenSSF scorecard](https://github.com/ossf/scorecard) to It is additionally triggered automatically when branch protection rules are changed. Callers must include `secrets: inherit` in order for the appropriate access tokens to be passed to this workflow. +#### KEMs and signatures continuous benchmarking (`kem-bench.yml` and `sig-bench-yml`) + +These workflows execute a benchmarkig framework to retrieve the performance of KEM and signature algorithms in CPU cycles. +When new algorithms are added to the codebase, they must be included inside the algorithms matrices found within these files. + ## Travis CI In the past, we used Travis CI to test on [some IBM platforms](PLATFORMS.md#tier-3-1) that are not supported by GitHub Actions.