Skip to content

fix(docs): address remaining audit followup items - #39

Merged
williaby merged 4 commits into
mainfrom
fix/audit-followup
Apr 24, 2026
Merged

williaby merged 4 commits into
mainfrom
fix/audit-followup

Conversation

@williaby

@williaby williaby commented Apr 23, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Audit followup (3 items):

  • CHANGELOG.md: Added a note explaining the intentional date-based versioning scheme; this is a shared workflow library with continuous deployment and no numbered releases.
  • SECURITY.md: Replaced the placeholder v1.x/v2.x/v3.x supported-versions table with an accurate description. Also removed the orphaned `[upgrade-guide]` link definition and fixed an MD036 lint warning.
  • docs/RECOMMENDED_NEXT_STEPS.md:24: Removed prose AI-pattern word "comprehensive".

Dependency updates (2 actions):

  • `aquasecurity/trivy-action`: v0.35.0 -> v0.36.0 (3 workflow files)
  • `step-security/harden-runner`: v2.18.0 -> v2.19.0 (21 workflow files)

Note: `slsa-framework/slsa-github-generator` was flagged as outdatable to v2.1.0-rc.3 but skipped; v2.1.0 is the stable release. The update script picks up pre-release tags via lexicographic comparison.

Test plan

  • Verify CHANGELOG.md renders correctly on GitHub (date-based versioning note is readable)
  • Verify SECURITY.md no longer references fictional version numbers or upgrade-guide
  • Confirm markdownlint passes (MD036 and MD053 warnings resolved)
  • Verify workflow files reference correct new action SHAs
  • Confirm no regressions in existing workflow behavior

Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Updated pinned GitHub Actions for CI security tooling (harden-runner bumped to v2.19.0; Trivy action bumped to v0.36.0) across workflows.
  • Documentation
    • Security policy updated to a continuous-deployment model with main as the supported branch and refreshed timestamp.
    • Support docs and changelog clarified repository versioning and minor wording/format tweaks.

- CHANGELOG.md: document intentional date-based versioning scheme;
  this is a workflow library with continuous deployment, not semver releases
- SECURITY.md: replace fictional v1.x/v2.x/v3.x version table with
  accurate description; repo has no numbered releases, main is supported
- docs/RECOMMENDED_NEXT_STEPS.md: remove prose AI-pattern word "comprehensive"

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Apr 23, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2e459ec6-7455-4750-849b-93fb13af186e

📥 Commits

Reviewing files that changed from the base of the PR and between 244de23 and 7c4b199.

📒 Files selected for processing (1)
  • SECURITY.md
✅ Files skipped from review due to trivial changes (1)
  • SECURITY.md

📝 Walkthrough

Walkthrough

This PR updates GitHub Actions versions across 19 workflow files (step-security/harden-runner from v2.18.0 to v2.19.0, aquasecurity/trivy-action from v0.35.0 to v0.36.0 in select workflows) and updates supporting documentation policies and guidance.

Changes

Cohort / File(s) Summary
Harden Runner Action Updates (v2.18.0 → v2.19.0)
.github/workflows/python-ci.yml, python-codecov.yml, python-compatibility.yml, python-docs.yml, python-fuzzing.yml, python-mutation.yml, python-performance-regression.yml, python-qlty-coverage.yml, python-reuse.yml, python-scorecard.yml, shell-tests.yml
Updated step-security/harden-runner commit pin from v2.18.0 to v2.19.0 across 11 workflows; with: egress-policy: audit unchanged.
Harden Runner + Additional Tooling Updates
.github/workflows/python-container-security.yml, python-docker.yml, python-sbom.yml
Bumped step-security/harden-runner to v2.19.0 and aquasecurity/trivy-action from v0.35.0 → v0.36.0 where applicable; scan/SBOM step inputs preserved.
Multi-Job Harden Runner Updates
.github/workflows/python-ci.yml, python-fips-compatibility.yml, python-pr-validation.yml, python-publish-pypi.yml, python-release.yml, python-security-analysis.yml, python-sonarcloud.yml, python-supplemental-checks.yml
Updated harden-runner pin to v2.19.0 in multiple jobs per workflow; step logic and egress settings unchanged.
Documentation & Policy Updates
CHANGELOG.md, SECURITY.md, SUPPORT.md, docs/RECOMMENDED_NEXT_STEPS.md
Clarified changelog header scheme; changed SECURITY and SUPPORT wording to a main-branch continuous-deployment model; refreshed “Last updated” timestamps and minor editorial fixes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 Action pins hop to the latest release,
From v2.18 to v2.19 with ease!
Trivy tunes its scanning song,
Docs refreshed and timestamps long,
A rabbit pats the workflows, light and breezy.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: audit followup items (documentation updates) and dependency version updates across workflow files.
Description check ✅ Passed The pull request description is comprehensive and well-structured, clearly documenting audit followup items, dependency updates, test plan, and relevant notes about skipped updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/audit-followup

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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documentation-only PR to close remaining standards-audit follow-ups by aligning community health docs with the repo’s actual release/versioning model (date-based changelog entries, continuous deployment, and “main is supported”).

Changes:

  • Add a changelog header note clarifying date-based version headers (not semver).
  • Replace the fictional supported-versions table in SECURITY.md with guidance that main is the supported version, and remove the orphaned upgrade-guide reference.
  • Minor prose cleanup in docs/RECOMMENDED_NEXT_STEPS.md.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/RECOMMENDED_NEXT_STEPS.md Removes an “AI-pattern” adjective from a completed-workflows summary line.
SECURITY.md Updates “Supported Versions” to reflect continuous deployment/no numbered releases; removes orphaned link definition; resolves markdown linting issue for “Last updated”.
CHANGELOG.md Documents date-based version headers to explain deviation from semver expectations.

- aquasecurity/trivy-action: v0.35.0 -> v0.36.0 (3 files)
- step-security/harden-runner: v2.18.0 -> v2.19.0 (21 files)

Skipped: slsa-framework/slsa-github-generator shows v2.1.0-rc.3 as
"newer" due to lexicographic tag comparison; v2.1.0 is the stable
release and the correct pin to keep.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@williaby

Copy link
Copy Markdown
Collaborator Author

@github-copilot review

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 24 out of 24 changed files in this pull request and generated 2 comments.

Comment thread SECURITY.md Resolved
Comment thread SECURITY.md Resolved
@williaby

Copy link
Copy Markdown
Collaborator Author

PR Review

Important (should fix before merge)

  • SECURITY.md:61: Stale "Last updated: November 16, 2025" — this file was substantively edited in this PR; timestamp should reflect the merge date.

Suggested

  • SUPPORT.md:31-32: Cross-reference reads "details on which versions are in scope" but SECURITY.md no longer has a version scope table; it now says "main branch is always the supported version." Sentence is semantically misleading.
  • Pre-existing trailing whitespace throughout SECURITY.md (e.g. ## Security Practices ) — pre-commit run --all-files would remove these.

All CI checks passing. GitHub Copilot reviewed 3/3 changed files, generated no comments. SonarQube not configured.

🤖 Generated with Claude Code

- Update "Last updated" timestamps to April 23, 2026 in both files
- Strip pre-existing trailing whitespace from SECURITY.md headings and
  list items (no rendering impact; fixes markdownlint MD009)
- Rewrite SUPPORT.md Supported Versions section to match the continuous
  deployment model described in SECURITY.md; previous text referenced a
  fictional versioned release table that no longer exists
- Fix MD036 italic-emphasis on SUPPORT.md "Last updated" line

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@williaby

Copy link
Copy Markdown
Collaborator Author

PR Fix Summary

Addressed 3 findings in commit 244de2345729bd0ac8206afa2acc312b64689abb:

Important (fixed)

  • SECURITY.md:61: Updated stale "Last updated" timestamp from November 16, 2025 to April 23, 2026.

Suggested (fixed)

  • SUPPORT.md:30-32: Rewrote Supported Versions section to align with the continuous deployment model now described in SECURITY.md. Removed misleading reference to a versioned release table that no longer exists. Updated stale timestamp and removed MD036 italic emphasis.
  • SECURITY.md (trailing whitespace): Stripped pre-existing trailing spaces from all headings and list items throughout the file. No rendering impact; resolves markdownlint MD009.

Informational (no action needed)

  • PR description trivy count (6 vs 7 locations): description-only inaccuracy, code correct.
  • Missing Why section: context is clear from Summary.
  • Vague "All other commits" prose: acceptable as written.

Pre-commit not configured in this repo; changes verified manually. CI re-run triggered by push.

🤖 Generated with Claude Code

- Clarify SHA-pin update model: "must update their pin to a newer commit
  on main" replaces vague "will receive security fixes when they update
  their pin", and "Older commits" replaces ambiguous "All other commits"
- Replace "release notes and upgrade guide" with "Security Advisory and
  CHANGELOG" in CVE workflow step 3; the old wording referenced artifacts
  that do not exist in this continuous-deployment repository

Addresses Copilot review comments on PR #39.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@williaby

Copy link
Copy Markdown
Collaborator Author

Addressed both Copilot review comments in 7c4b19942dacd58bb7a20fbc6ab7f856208c1d70:

  1. "All other commits" ambiguity — Rewrote to: "Callers that pin to a specific commit SHA must update their pin to a newer commit on main to receive security fixes. Older commits may not contain the latest security patches."
  2. "Release notes and upgrade guide" conflict — Updated CVE workflow step 3 to "Include remediation steps in the Security Advisory and CHANGELOG" to align with the no-numbered-releases policy.

🤖 Generated with Claude Code

@williaby
williaby merged commit d18c930 into main Apr 24, 2026
5 checks passed
@williaby
williaby deleted the fix/audit-followup branch April 24, 2026 00:55
@coderabbitai coderabbitai Bot mentioned this pull request May 8, 2026
3 tasks
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