Skip to content

docs: add GitHub Actions CI integration examples#60

Open
dmchaledev wants to merge 1 commit into
mainfrom
claude/nice-mendel-g2oSi
Open

docs: add GitHub Actions CI integration examples#60
dmchaledev wants to merge 1 commit into
mainfrom
claude/nice-mendel-g2oSi

Conversation

@dmchaledev
Copy link
Copy Markdown
Contributor

Summary

  • The README described the tool as a "CI gate" but only showed a bare one-liner (|| echo "Gate failed"), leaving users to figure out the workflow integration themselves
  • Added a dedicated CI Integration section with three copy-pasteable GitHub Actions patterns

What's added

Pattern Purpose
Blocking gate Fails the workflow when grade is D or F — the primary use case
Informational audit Always passes; useful during a remediation period or for visibility without blocking
JSON artifact export Saves the full report as a downloadable workflow artifact for audit trails

Why this is high-leverage

The CI gate use case is explicitly called out in the README's "Who Is This For" section ("automated header auditing on every deployment"), but there was no example showing how to wire it up. A copy-pasteable workflow lowers the adoption barrier to near zero for the tool's primary audience (DevSecOps teams, security engineers).

Test plan

  • Verify Markdown renders correctly (no broken code fences)
  • Confirm the three YAML snippets are valid GitHub Actions syntax
  • Spot-check that the || true pattern correctly suppresses the non-zero exit

https://claude.ai/code/session_01FV2i2kr45Q4ztmCtTz8xzv


Generated by Claude Code

The tool is positioned as a CI gate but the README only showed a
one-liner with ||. Added a dedicated section with three copy-pasteable
GitHub Actions patterns: blocking gate, informational audit, and JSON
artifact export.

https://claude.ai/code/session_01FV2i2kr45Q4ztmCtTz8xzv
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants