Moving continuous benchmarking to weekly tests (#2276)

* Moved continuous benchmarking to weekly tests

Signed-off-by: Pablo Gutiérrez <pablogf@uma.es>

* Update CI.md

Signed-off-by: Pablo Gutiérrez <pablogf@uma.es>

* Cleaned CI.md

Signed-off-by: Pablo Gutiérrez <pablogf@uma.es>

---------

Signed-off-by: Pablo Gutiérrez <pablogf@uma.es>
This commit is contained in:
Pablo Gutiérrez 2025-09-18 15:33:55 +02:00 committed by GitHub
parent 9a81240cd5
commit 6e6ffa5082
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 18 additions and 13 deletions

View File

@ -7,7 +7,7 @@
<!-- Please answer the following questions to help manage version and changes across projects. -->
* [ ] 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)
<!-- If this contribution (code, documentation, descriptive text) was produced with the help of generative AI, please describe the nature of the use. Contributors are expected to have verified and affirm such contributions themselves before submission. -->

View File

@ -27,13 +27,3 @@ 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

View File

@ -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

7
CI.md
View File

@ -36,7 +36,7 @@ It calls [platform tests](#platforms.yml), [code coverage tests](#code-coverage.
#### <a name="weekly.yml"></a> 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)
#### <a name="release.yml"></a> 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.
#### <a name="kem-bench.yml-sig-bench.yml"></a> 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.