open-quantum-safe / liboqs / 25798125987 / 2
82%
main: 82%

DEFAULT BRANCH: main
Ran
Files 1789
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 60.293% (+0.001%) from 60.292%
25798125987.2

push

github

web-flow 
Create a table of algorithm support levels (#2413)

* Document per-algorithm support levels

Adds three top-level fields to every algorithm YAML datasheet —
`upstream-maintenance`, `upstream-statement-url`, and `oqs-support-tier`
— and extends the generators to render them into the README support
table, a new top-level ALGORITHMS.md, and a Support section on each
per-algorithm page.

ALGORITHMS.md hosts the authoritative upstream-maintenance vocabulary
and OQS support-tier definitions inline, with three generated summary
tables (one per algorithm category) spliced between
`OQS_TEMPLATE_FRAGMENT_ALGORITHMS_*` markers. Everything else in
ALGORITHMS.md is hand-maintained and can be edited directly.

Initial tier assignments: Tier 1 ML-KEM; Tier 2 FrodoKEM, HQC, ML-DSA,
LMS, XMSS; Tier 3 all remaining families. ML-KEM and ML-DSA start with
`upstream-maintenance: Actively maintained`; Classic McEliece starts
with `No active maintenance` citing PQClean's wind-down; every other
family starts at `TBD` pending outreach.

A new `docs-sync` CI workflow regenerates the docs from the YAMLs on
every PR touching the algorithm sources and fails if the generated
content drifts. Introduces `tests/test_alg_support_generators.py`
covering the new columns, vocabulary glossary, and per-family row shape.

Fixes #2045.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>

* Regenerate algorithm support tables and per-algorithm pages

Runs scripts/update_docs_from_yaml.py against the support-level YAML
fields and fragment-marker infrastructure added in the previous commit.
This populates the algorithm-support table in README.md, the three
per-category summary tables in ALGORITHMS.md, and a Support section on
every per-algorithm markdown page.

Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>

* Limit scope of GitHub token in workflow

Co-authored-by: Copilot Autofix powered by AI <62310815+github-a... (continued)

90666 of 150375 relevant lines covered (60.29%)

4450476.78 hits per line

Source Files on job arm64-distbuild - 25798125987.2