fix(release): improve release PR descriptions #265

Merged
jwilger merged 4 commits from fix/release-pr-descriptions into main 2026-05-19 06:16:03 -07:00
Owner

Why:

  • Release PRs need enough context for reviewers and Auto Review to assess them without accepting generic metadata.
  • Agents also need clearer RGR planning guidance so upfront requirements do not become speculative pre-planned cycle queues.

What:

  • Make generated release PR descriptions mention the release branch, scripts/release prepare, semver-selected metadata, and changed release metadata files.
  • Tighten the release-prepare contract to reject generic two-sentence PR bodies.
  • Update Auto Review's deterministic release metadata gate to accept the new substantive release body shape and stop bypassing weak generic release bodies.
  • Clarify the RGR planning skill: define behavioral requirements up front, then drive only the active observable behavior through RED-GREEN-REFACTOR.

Validation:

  • cargo nextest run -p ar-gateway --test ci_workflow_contract release_prepare_creates_mergeable_release_pr_description
  • cargo nextest run -p ar-review release_pr_metadata
  • cargo fmt --all -- --check
  • just opencode-test
Why: - Release PRs need enough context for reviewers and Auto Review to assess them without accepting generic metadata. - Agents also need clearer RGR planning guidance so upfront requirements do not become speculative pre-planned cycle queues. What: - Make generated release PR descriptions mention the release branch, `scripts/release prepare`, semver-selected metadata, and changed release metadata files. - Tighten the release-prepare contract to reject generic two-sentence PR bodies. - Update Auto Review's deterministic release metadata gate to accept the new substantive release body shape and stop bypassing weak generic release bodies. - Clarify the RGR planning skill: define behavioral requirements up front, then drive only the active observable behavior through RED-GREEN-REFACTOR. Validation: - `cargo nextest run -p ar-gateway --test ci_workflow_contract release_prepare_creates_mergeable_release_pr_description` - `cargo nextest run -p ar-review release_pr_metadata` - `cargo fmt --all -- --check` - `just opencode-test`
Why:
- Release PRs need enough context for reviewers and Auto Review to assess them without treating generic metadata as acceptable.

What:
- Make generated release PR descriptions mention the release branch, scripts/release preparation path, semver-selected metadata, and changed release metadata files.
- Tighten the release-prepare contract to reject generic two-sentence PR bodies.

Validation:
- cargo nextest run -p ar-gateway --test ci_workflow_contract release_prepare_creates_mergeable_release_pr_description
- cargo fmt --all -- --check
Why:
- Agents need to distinguish behavioral requirement planning from speculative pre-planned RGR cycle queues.

What:
- Update the RGR planning skill to require behavior checklists up front and only one active RED target at a time.

Validation:
- just opencode-test
Why:
- Release PR metadata should not bypass quality checks with generic bodies, while generated substantive release descriptions should avoid false negatives.

What:
- Accept the concrete release-prepare body shape with explicit release metadata evidence.
- Add regression coverage that rejects weak generic release bodies.

Validation:
- cargo nextest run -p ar-review release_pr_metadata_gate_accepts_concrete_release_prepare_body_without_weak_generic_bypass
- cargo fmt --all -- --check
test(review): update release metadata fixtures
All checks were successful
CI / Classify changed paths (pull_request) Successful in 3s
CI / Format check (pull_request) Successful in 6s
CI / Clippy (pull_request) Successful in 40s
CI / opencode plugin tests (pull_request) Successful in 13s
CI / Test (pull_request) Successful in 53s
CI / Dependency policy (pull_request) Successful in 8s
CI / Request auto_review semantic review (pull_request) Successful in 1s
auto_review auto_review: no findings
CI / Build (pull_request) Successful in 31s
CI / Build PR artifacts (no token) (pull_request) Successful in 2s
be975fd284
Why:
- Broader release metadata verification should exercise the substantive release PR body contract instead of obsolete generic release bodies.

What:
- Update release metadata false-negative fixtures to use the concrete release-prepare body shape.

Validation:
- cargo nextest run -p ar-review release_pr_metadata
- cargo fmt --all -- --check
auto-review left a comment

The PR enhances release PR descriptions by including specific metadata and branch details, improving clarity for reviewers. It updates tests and workflows to enforce these new description standards. The changes appear safe to merge, with no identified issues.

Walkthrough

  • .forgejo/workflows/release-prepare.yml:
    • Updated the tea pr create and tea pr edit commands to include more detailed descriptions in release PRs.
  • .opencode/skills/rgr-plan-structure/SKILL.md:
    • Revised the RGR planning guidance to focus on upfront behavior checklists and discourage speculative cycle planning.
  • crates/ar-gateway/tests/ci_workflow_contract.rs:
    • Modified tests to ensure release PR descriptions contain concrete evidence of release preparation.
  • crates/ar-review/src/pipeline.rs:
    • Updated the function to check for specific metadata in release PR descriptions, ensuring they meet the new standards.

LLM usage and cost

The PR enhances release PR descriptions by including specific metadata and branch details, improving clarity for reviewers. It updates tests and workflows to enforce these new description standards. The changes appear safe to merge, with no identified issues. ## Walkthrough - **.forgejo/workflows/release-prepare.yml**: - Updated the `tea pr create` and `tea pr edit` commands to include more detailed descriptions in release PRs. - **.opencode/skills/rgr-plan-structure/SKILL.md**: - Revised the RGR planning guidance to focus on upfront behavior checklists and discourage speculative cycle planning. - **crates/ar-gateway/tests/ci_workflow_contract.rs**: - Modified tests to ensure release PR descriptions contain concrete evidence of release preparation. - **crates/ar-review/src/pipeline.rs**: - Updated the function to check for specific metadata in release PR descriptions, ensuring they meet the new standards. ## LLM usage and cost - Reasoning (gpt-4o) in=5774 out=564 cost=$0.037330 - Cheap (gpt-4o-mini) in=475 out=44 cost=$0.000098 Estimated total USD: $0.037428 via https://api.openai.com and https://api.openai.com
jwilger deleted branch fix/release-pr-descriptions 2026-05-19 06:16:03 -07:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Slipstream/auto_review!265
No description provided.