Skip to content

docs(dev-cycle): #126 — add §4.5.6 Workflow security hardening#525

Merged
jinhongkuan merged 1 commit into
devfrom
docs/126-ci-hardening-section
Jun 1, 2026
Merged

docs(dev-cycle): #126 — add §4.5.6 Workflow security hardening#525
jinhongkuan merged 1 commit into
devfrom
docs/126-ci-hardening-section

Conversation

@Knapp-Kevin

Copy link
Copy Markdown
Collaborator

Summary

Closes #126.

Adds a new subsection §4.5.6 Workflow security hardening to docs/DEV_CYCLE.md capturing the durable CI-author principles the #114 audit asked us to document. Pure additive — no existing content modified, 91 insertions / 0 deletions.

What's in the new section

Acceptance check

  • New section captures the four principles named in the issue body
  • References the existing inline note at .github/workflows/pr-body-refs-lint.yml rather than restating it
  • Numbering preserved (§4.5.1 → … → §4.5.5 → §4.5.6 → §4.6)
  • No top-level TOC in this doc to update (verified)
  • Relative markdown links validated (../.github/... from docs/DEV_CYCLE.md)

Backward compatibility

  • Data migration: N/A — pure docs.
  • Wire format: N/A — no tool change.
  • Skill contract: N/A — no skill change.

Risk

L1 — additive documentation.

Captures the durable CI-author principles the #114 audit asked for:
input handling (os.environ over shell interpolation, the OWASP A03
hazard), trigger choice (pull_request vs pull_request_target),
permissions scoping (least privilege at workflow, widen per-job), and
required-check deadlocks (paths: + branch-protection interaction,
workflow_dispatch as the escape hatch).

Anchor case studies link to the existing inline notes so this section
stays an index rather than duplicating workflow-specific detail that
should live next to the workflow.

Pure additive doc change — new subsection between §4.5.5 and §4.6, no
existing content modified. Risk L1.

Closes #126

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Knapp-Kevin Knapp-Kevin added documentation Improvements or additions to documentation enhancement New feature or request flow:feature Standard feature/fix PR targeting BicameralAI/dev (the default flow) labels May 27, 2026
@coderabbitai

coderabbitai Bot commented May 27, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5398938e-828a-47a4-8c17-be8d08b27a76

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/126-ci-hardening-section

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Knapp-Kevin Knapp-Kevin marked this pull request as ready for review May 27, 2026 06:07
@jinhongkuan jinhongkuan merged commit 0827444 into dev Jun 1, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request flow:feature Standard feature/fix PR targeting BicameralAI/dev (the default flow)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants