Skip to content

Add release evidence issue body sync#236

Merged
punk6529 merged 3 commits into
mainfrom
codex/release-evidence-issue-bodies
Jun 13, 2026
Merged

Add release evidence issue body sync#236
punk6529 merged 3 commits into
mainfrom
codex/release-evidence-issue-bodies

Conversation

@punk6529

@punk6529 punk6529 commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add deterministic release-evidence-issue-body-sync JSON and Markdown artifacts that join the generated release evidence backlog with the committed issue-link map.
  • Wire the body-sync artifact into local checks, CI, release manifest/checksum coverage, release-readiness checks, docs, changelog, roadmap, and durable autonomous run state.
  • Apply the generated exact body payloads to GitHub tracker issues Retain public beta evidence: external_audit_report #215 through Retain production release evidence: post_audit_remediation #231, leaving those issues open because retained external evidence is still required.

Closes #235.

Validation

  • python -m py_compile scripts/generate_release_evidence_issue_body_sync.py scripts/test_release_evidence_issue_body_sync.py
  • python scripts/generate_release_evidence_issue_body_sync.py
  • python scripts/test_release_evidence_issue_body_sync.py
  • python scripts/generate_release_evidence_issue_body_sync.py --check
  • python scripts/test_release_artifacts.py
  • python scripts/generate_release_artifacts.py --check
  • python scripts/test_release_manifest.py
  • python scripts/generate_release_manifest.py --check
  • python scripts/test_release_checksums.py
  • python scripts/generate_release_checksums.py --check
  • python scripts/test_release_readiness.py
  • python scripts/check_release_readiness.py
  • python scripts/test_changelog_check.py
  • python scripts/check_changelog.py
  • bash -n scripts/check.sh
  • PowerShell parser check for scripts/check.ps1
  • git diff --check
  • make check
  • powershell -ExecutionPolicy Bypass -File scripts\check.ps1
  • Verified live GitHub bodies for issues Retain public beta evidence: external_audit_report #215 through Retain production release evidence: post_audit_remediation #231 match release-artifacts/latest/release-evidence-issue-body-sync.json after trailing-newline normalization.

Readiness Notes

This PR is tracker-only and no-secret. It does not mark public-beta or production-release evidence complete, does not close the child evidence tracker issues, and does not change release readiness claims.

Summary by CodeRabbit

  • New Features

    • Added release evidence issue body sync artifacts (JSON & Markdown) to produce deterministic expected GitHub issue bodies.
  • Documentation

    • Updated release-readiness, tooling, public-beta-evidence, roadmap, and artifact README to include the new body-sync outputs and verification steps.
  • Chores

    • Integrated body-sync generation/check into CI and release-manifest gating and updated artifact checksums.
  • Tests

    • Added unit and integration tests to validate generation, drift detection, and error handling for the body-sync artifacts.

@claude claude Bot 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.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8df4d634-482d-4180-92df-4a0933cb0672

📥 Commits

Reviewing files that changed from the base of the PR and between 285b942 and 4606bb1.

📒 Files selected for processing (6)
  • docs/tooling.md
  • ops/AUTONOMOUS_RUN.md
  • ops/ROADMAP.md
  • release-artifacts/latest/SHA256SUMS
  • release-artifacts/latest/release-checksums.json
  • release-artifacts/latest/release-manifest.json
✅ Files skipped from review due to trivial changes (3)
  • release-artifacts/latest/release-checksums.json
  • release-artifacts/latest/release-manifest.json
  • ops/ROADMAP.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • release-artifacts/latest/SHA256SUMS
  • docs/tooling.md

📝 Walkthrough

Walkthrough

This PR implements a deterministic release-evidence issue body sync generator that constructs exact GitHub issue body payloads for tracker issues #215#231 by joining backlog and issue-link sources. The change adds ~2,700 lines including a new generator script with full validation, comprehensive test coverage, CI/Makefile wiring, generated JSON/Markdown artifacts, checksum updates, documentation, and operational state tracking.

Changes

Release Evidence Issue Body Sync

Layer / File(s) Summary
Generator implementation and core logic
scripts/generate_release_evidence_issue_body_sync.py
Deterministic script that loads backlog/issue-links JSON, validates policy/consistency, builds expected issue bodies with SHA-256 digests, renders Markdown, and supports write/--check modes for CI and local verification.
Unit tests for validation and error handling
scripts/test_release_evidence_issue_body_sync.py
Eight test cases covering committed artifact freshness, payload generation from minimal fixtures, required heading validation, stale link rejection, duplicate issue detection, drift detection in --check mode, secret-like payload rejection, and UTF-8 encoding error handling.
CI workflow and Makefile wiring
.github/workflows/ci.yml, Makefile, scripts/check.ps1, scripts/check.sh
Hooks generator and test scripts into GitHub Actions (repository hygiene and release-evidence sections), adds Makefile targets release-evidence-issue-body-sync and -check, wires into check and release-manifest dependencies, and adds corresponding shell/PowerShell steps.
Release readiness checker updates
scripts/check_release_readiness.py
Requires phrase "release evidence issue body sync" in dashboard text, adds test/generator --check commands to REQUIRED_COMMANDS, and adds JSON/Markdown links to REQUIRED_LINK_TARGETS.
Release manifest builder and artifact filtering
scripts/generate_release_manifest.py, scripts/generate_release_artifacts.py, scripts/test_release_artifacts.py, scripts/test_release_manifest.py
Adds filename constants and manifest builder code for release-evidence-issue-body-sync entries, filters generated files from comparison logic, and updates test fixtures to validate new artifacts.
Generated issue body sync JSON manifest
release-artifacts/latest/release-evidence-issue-body-sync.json
Deterministic manifest with schema/policy metadata, 17 tracker issue entries (#215#231), per-entry requirement info, issue numbers/URLs, source/body SHA256 hashes, and complete expected body payloads.
Generated issue body sync Markdown review view
release-artifacts/latest/release-evidence-issue-body-sync.md
Human-readable document with source/policy tables, per-issue sections for all tracker entries, including requirement metadata, evidence expectations, completion gates, validation commands, and acceptance criteria (1,111 lines).
Checksum entries and manifest updates
release-artifacts/latest/SHA256SUMS, release-artifacts/latest/release-checksums.json, release-artifacts/latest/release-manifest.json
Updated checksums for new body-sync artifacts and refreshed manifest; extended manifest with release_evidence_issue_body_sync object containing file records and SHA256/size metadata.
Documentation: CHANGELOG and procedural guides
CHANGELOG.md, docs/public-beta-evidence.md, docs/release-readiness.md, docs/tooling.md, release-artifacts/README.md
Documented new artifacts in changelog, added procedural workflow step for body-sync regeneration, updated release-readiness intake/checklists/required-links, included in Gate A checks and release-checksum coverage, and updated release-artifacts README.
Autonomous run state and roadmap advancement
ops/AUTONOMOUS_RUN.md, ops/ROADMAP.md
Transitioned from Queue Item 111 completion (PR #234) to Queue Item 112 activation (PR #236) for issue-body sync application; updated verification metadata, Gate G evidence requirements, and release-artifact baseline.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

Poem

🐰 A generator rabbit hops with glee,
Joining backlog bodies deterministically!
No secrets slip through this careful sweep,
Issue trackers synced, for readiness to keep.
Hops off to verify checksums deep.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically summarizes the main change: adding release evidence issue body sync functionality to the repository.
Linked Issues check ✅ Passed The PR fully addresses all coding requirements from issue #235: deterministic body-sync artifact, tests/checks, manifest/checksum coverage, documentation, and GitHub issue body application.
Out of Scope Changes check ✅ Passed All changes are tightly scoped to implementing release evidence issue body sync; no unrelated modifications or scope creep detected.
Docstring Coverage ✅ Passed Docstring coverage is 87.50% which is sufficient. The required threshold is 80.00%.

✏️ 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 codex/release-evidence-issue-bodies

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

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/tooling.md`:
- Around line 266-268: Summary: The checksum coverage paragraph omits the
committed issue-link map file. Edit the paragraph that currently lists
"release-evidence-issue backlog" and "release-evidence-issue body-sync" to also
mention the committed issue-link map (release-evidence-issue-links.json) so the
checksum coverage list includes the tracker-map alongside
release-evidence-issue-body-sync.

In `@ops/ROADMAP.md`:
- Around line 384-385: Update the ROADMAP text that references issue "`#235`" to
mark that issue as complete and remove the phrase "current PR"; replace "current
PR" with the explicit PR number that closed `#235` (or just reference the issue
"`#235`" alone), and apply the same wording fix to any other occurrences of
"current PR" related to this body-sync work elsewhere in the document.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 70982dee-1984-4c04-9e7b-22884e35b021

📥 Commits

Reviewing files that changed from the base of the PR and between 1ac0765 and 285b942.

📒 Files selected for processing (24)
  • .github/workflows/ci.yml
  • CHANGELOG.md
  • Makefile
  • docs/public-beta-evidence.md
  • docs/release-readiness.md
  • docs/tooling.md
  • ops/AUTONOMOUS_RUN.md
  • ops/ROADMAP.md
  • release-artifacts/README.md
  • release-artifacts/latest/SHA256SUMS
  • release-artifacts/latest/release-checksums.json
  • release-artifacts/latest/release-evidence-issue-body-sync.json
  • release-artifacts/latest/release-evidence-issue-body-sync.md
  • release-artifacts/latest/release-manifest.json
  • scripts/check.ps1
  • scripts/check.sh
  • scripts/check_release_readiness.py
  • scripts/generate_release_artifacts.py
  • scripts/generate_release_evidence_issue_body_sync.py
  • scripts/generate_release_manifest.py
  • scripts/test_release_artifacts.py
  • scripts/test_release_evidence_issue_body_sync.py
  • scripts/test_release_manifest.py
  • scripts/test_release_readiness.py

Comment thread docs/tooling.md Outdated
Comment thread ops/ROADMAP.md Outdated
@punk6529

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@punk6529 punk6529 merged commit 1a82546 into main Jun 13, 2026
2 checks passed
punk6529 added a commit that referenced this pull request Jun 13, 2026
Record PR #236 merge evidence, tracker-label reconciliation, refreshed roadmap verification metadata, and the next no-secret evidence tracker hardening target without changing readiness claims.
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.

Generate and apply release evidence tracker issue bodies

1 participant