Skip to content

docs(phase-2-3): Add next session prompt with PR and issue references - #1388

Open
ashleyshaw wants to merge 4 commits into
developfrom
docs/phase-2-3-next-session-prompt
Open

docs(phase-2-3): Add next session prompt with PR and issue references#1388
ashleyshaw wants to merge 4 commits into
developfrom
docs/phase-2-3-next-session-prompt

Conversation

@ashleyshaw

@ashleyshaw ashleyshaw commented Jul 26, 2026

Copy link
Copy Markdown
Member

Documentation Pull Request

Linked issues

Relates to #1227, #1309, #1386

What changed

  • Next session prompt for Phase 2.3 Integration Testing and Phase 3 planning handoff
  • Two execution options and step-by-step continuation context

Audience & placement

  • Audience: Contributors continuing the workflows consolidation work
  • Location: .github/projects/active/workflows-consolidation-2026-q3/

Notes

Comprehensive handoff document referencing PR #1387, Issue #1386, Issue #1309, and Epic #1227.

Changelog

Added

  • GitHub Workflows Consolidation — Phase 2.3 next-session prompt — Continuation handoff document with two execution options and full context for Phase 2.3 integration testing and Phase 3 planning. (PR #1388, #1227)

Checklist (Global DoD / PR)

  • All AC met and demonstrated
  • Tests added/updated (unit/E2E as appropriate)
  • Accessibility checklist completed (where relevant)
  • Docs/readme/changelog updated (if user-facing)
  • Security checklist completed (where relevant)
  • Code/design reviews approved
  • CI green; linked issues closed; release notes prepared (if shipping)

ashleyshaw and others added 4 commits July 24, 2026 19:39
Remove 3 legacy workflows consolidated into documentation.yml:
- Delete .github/workflows/readme-audit.yml (189 lines)
- Delete .github/workflows/readme-regen.yml (111 lines)
- Delete .github/workflows/readme-update.yml (149 lines)

Re-enable push trigger in documentation.yml now that legacy workflows
are removed and no race conditions exist. The regenerate job will now
automatically run on push to develop with matching path filters.

Cleanup Phase (Issue #1310):
✅ All 3 legacy workflows deleted
✅ Push trigger re-enabled in documentation.yml
✅ Total: 449 lines removed, ~44% code deduplication

Related: Epic #1227 (Phase 2 Consolidation), Issue #1310

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Add entry for Phase 2.4 (GitHub Workflows Consolidation - Cleanup) which removed
3 legacy README workflows consolidated into documentation.yml.

Part of PR #1317 - cleanup legacy README workflows
## Security Fixes

- Scope workflow permissions: Remove broad top-level permissions, move read-only
  to global, add job-specific write permissions only where needed (audit, regenerate, maintain)
- Add persist-credentials: false to read-only checkouts (audit job)
- Improve shell script quoting and variable handling in resolve-readme-files.sh
- Add documentation clarifying comma-separated output format

## Correctness Fixes

- Fix maintenance report accuracy: Only show success when steps actually succeed
  (add step IDs, capture outcomes, display actual status in report)
- Fix README resolver over-inclusion: Only add root README when subdirectory files
  change, not on every change (reduce noise and unnecessary regenerations)
- Improve documentation: Add detailed comments explaining output format and
  security considerations

## Implementation Details

- audit job: permissions read + pull-requests:write + issues:write
- regenerate job: permissions contents:write + pull-requests:write
- maintain job: permissions contents:write
- All jobs: persist-credentials set appropriately (false for read-only, true for write)
- Maintenance report: Track mermaid, contrast, staleness outcomes separately

Addresses CodeRabbit feedback on PR #1317

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
## Summary

Comprehensive handoff document for Phase 2.3 Integration Testing and Phase 3 planning.
Includes links to:
- PR #1387: Security fixes (CodeRabbit feedback)
- Issue #1386: CodeRabbit feedback tracking
- Issue #1309: Phase 2.3 Integration Testing
- Epic #1227: GitHub Workflows Consolidation Initiative

## Content

Two prompt templates for next session:
1. Option 1: Merge security fixes → execute Phase 2.3 testing
2. Option 2: Execute Phase 2.3 testing → merge fixes later

Includes:
- Detailed context summary
- Current status tracking
- 5 test scenarios (ready to execute)
- Phase 3 design review (ready)
- All relevant documentation links
- Success criteria

Reference: .github/projects/active/workflows-consolidation-2026-q3/PHASE_2_3_NEXT_SESSION_PROMPT.md

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@ashleyshaw, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 20 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: ffab5c9c-858d-4ff9-9be7-870043c2d9b4

📥 Commits

Reviewing files that changed from the base of the PR and between 37734c1 and 763a92c.

📒 Files selected for processing (9)
  • .github/projects/active/workflows-consolidation-2026-q3/PHASE_2_3_INTEGRATION_TESTING.md
  • .github/projects/active/workflows-consolidation-2026-q3/PHASE_2_3_NEXT_SESSION_PROMPT.md
  • .github/workflows/documentation.yml
  • .github/workflows/readme-audit.yml
  • .github/workflows/readme-regen.yml
  • .github/workflows/readme-update.yml
  • CHANGELOG.md
  • scripts/workflows/resolve-readme-files.js
  • scripts/workflows/resolve-readme-files.sh
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/phase-2-3-next-session-prompt

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.

@github-actions

github-actions Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

✅ Template check passed after update. Thanks for fixing the PR description.

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.3: Integration Testing — Documentation Workflows

1 participant