ci(release): build full audit-deliverable compliance bundle (REQ-090)#322
Merged
Conversation
The v0.12.0 release attached a ~7 MB single-page navigation-shell HTML
bundle that auditors (per the v0.11.1 audit findings captured in
REQ-090) couldn't actually use for compliance review. The fix:
1. Compliance action gains an opt-in `include-data-formats` input
(default false — backward compatible). When true, the report
directory also gets:
- `requirements.reqif` (OMG ReqIF 1.2 — importable into DOORS /
Polarion / codeBeamer)
- `artifacts.yaml` (generic-yaml — diff-friendly, complete)
- `README.md` documenting the bundle layout and the importer
conventions for ReqIF.
2. Release workflow's `build-compliance` job:
- Sets `single-page: false` (the multi-page form, now ~50 MB on
the rivet corpus after REQ-088's shared-assets fix landed in
#319) — the documents/coverage/matrix/validate views auditors
actually use.
- Sets `include-data-formats: true` — ReqIF + generic-yaml +
README ship inside the same tarball.
Existing tarball / upload / `create-release` plumbing picks the new
contents up unchanged.
Smoke: `rivet export --format reqif` and `--format generic-yaml`
produce 2.6 MB / 628 KB on the rivet corpus (795 artifacts) — well
within the budget.
Implements: REQ-090
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
REQ-090 — the GitHub Release now attaches the audit-deliverable
compliance bundle (rendered docs + coverage + matrix + validate + ReqIF
v0.12.0 release shipped (which the v0.11.1 audit findings flagged as
unusable).
Changes
`include-data-formats` (default `false` so existing callers see
no behaviour change). When true, the report directory gains
`requirements.reqif`, `artifacts.yaml`, and a `README.md`
documenting the bundle layout and DOORS/Polarion/codeBeamer import
conventions.
sets `single-page: false` (the multi-page form) and
`include-data-formats: true`. Multi-page emission is now ~50 MB
total on the rivet corpus thanks to REQ-088's shared-assets fix
(feat(export): extract CSS/JS to shared _assets/ + thread --filter (REQ-087, REQ-088) #319), well within a GitHub Release artifact budget. Existing
tarball / upload / `create-release` plumbing picks the new
contents up unchanged.
Test plan
`--format generic-yaml --output …` produce 2.6 MB / 628 KB
on the rivet corpus (795 artifacts).
paving the way for.
🤖 Generated with Claude Code