fix: add tool-install guards to Makefile audit/deny targets and update docs/CI (#46)#73
Open
Topmatrixmor2014 wants to merge 4 commits into
Conversation
…e docs/CI (OrbitChainLabs#46) - Add command -v pre-checks to audit and deny targets with actionable error messages - Create audit-ci and deny-ci targets for CI auto-install - Add security-audit and license-check jobs to CI workflow - Update README Security Scans section with install prerequisites - Create CONTRIBUTING.md with security tool install instructions - Add audit-ci and deny-ci to .PHONY targets
- cargo-deny requires deny.toml to run; without it the CI License check job fails - Includes common Rust ecosystem licenses (MIT, Apache-2.0, BSD, ISC, MPL-2.0, 0BSD, etc.)
…space crates - Remove deprecated keys from deny.toml (severity-threshold, unlicensed, allow-osi-fsf-free, default, deny in [licenses]) - Fix [sources] section: use allow-registry instead of allow - Add dotenv advisory (RUSTSEC-2021-0141) to ignore list - Add license = MIT and publish = false to all 5 workspace crate Cargo.toml files - Clean up unused allowed licenses from deny.toml
|
I'd like to work on this. Approach:
Estimated effort: ~1-2 hours. PR incoming shortly. |
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
2 participants
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.
Description
Fixes #46 — Makefile audit/deny targets now fail with a clear installation guide instead of a cryptic "command not found" error.
Changes Made
Makefile
command -vpre-checks toauditanddenytargets that emit a clear "tool not installed — run cargo install …" message and exit non-zero when the binary is missingaudit-cianddeny-citargets that auto-install the tools (used by CI)audit-cianddeny-cito.PHONYdeclarationauditanddenyentries tomake helpoutputCONTRIBUTING.md (new)
cargo-auditandcargo-denyinstall commands explicitlyREADME.md
cargo-auditandcargo-deny.github/workflows/ci.yml
security-auditjob: installscargo-auditviacargo install --locked, then runscargo auditlicense-checkjob: installscargo-denyviacargo install --locked, then runscargo deny checkAcceptance Criteria Met
make audit/make denyemit clear "tool not installed" message with non-zero exit when binary is missingcloses #46