Uh oh!
There was an error while loading. Please reload this page.
test(phase-2-3): Scenario 2 - Push auto-commit regeneration - #1366
Closed
ashleyshaw wants to merge 8 commits into
Closed
test(phase-2-3): Scenario 2 - Push auto-commit regeneration#1366ashleyshaw wants to merge 8 commits into
ashleyshaw wants to merge 8 commits into
Conversation
… (Phase 2)
Consolidate 3 README workflows (readme-{audit,regen,update}.yml) into single
documentation.yml with conditional jobs for audit, regeneration, and maintenance.
**Scope revision:** Actual workflows differ from initial plan. Consolidating 3
workflows (not 5) with ~44% code deduplication (~200 lines). Phase 2 design
document created with implementation plan and testing strategy.
**Deliverables:**
- .github/workflows/documentation.yml (3 conditional jobs: audit, regenerate, maintain)
- PHASE_2_DOCS_CONSOLIDATION.md (design, implementation plan, testing strategy)
- Updated PROJECT_INDEX.md (Phase 2 status → IN PROGRESS)
**Validation:**
- Audit job: syntax, accessibility, contrast, staleness checks
- Regenerate job: auto-generate README on PR/push with dry-run on PR
- Maintain job: Mermaid fixes + staleness updates with dry-run option
**Effort:** 10-16 hours (revised down from 12-16, 3 workflows ≠ 5)
Related: Epic #1227 (workflows consolidation)
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>…n.yml Fixed validation errors by extracting complex shell logic to separate scripts: - Moved README file resolution logic to scripts/workflows/resolve-readme-files.js - Extracted bash helper script for file resolution (resolve-readme-files.sh) - Split "Run README regeneration" into separate PR/push conditional steps - Used execFileSync for secure git command execution All workflow validation errors resolved. Removed ~49 lines of complex shell control-flow by moving logic to appropriate script files. Related: PR #1313 (Phase 2 documentation consolidation) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Critical fixes for GitHub Actions workflow validation: 1. Fixed GITHUB_STEP_SUMMARY usage (was github.step_summary) - Collect validation outcomes properly - Use correct environment variable for step summary - Prevents silent audit failures 2. Removed continue-on-error from validation steps - Audit job now fails when validations fail - Properly propagates failures to notification handler - Makes audit job an effective validation gate 3. Disabled push trigger temporarily - Prevents race condition with legacy readme-regen.yml - Will be re-enabled after cleanup (Issue #1310) - Includes clear comment with reference to #1310 Also updated PR #1313 description with required template sections: - Linked issues documented - Changelog entry complete - Definition of Done checklist included - Global DoD checklist verified All Codex P1 issues addressed. Push trigger disabled pending cleanup. Related: PR #1313, Issue #1310 (Cleanup Old Workflows) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
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>
## Phase 2 Summary ✅ COMPLETE - Documentation consolidation merged (PR #1313, #1317): - Consolidated 3 README workflows → documentation.yml (1 unified workflow) - Fixed 4 critical GitHub Actions issues - Deleted 449 lines of legacy code (44% deduplication) - Push trigger re-enabled after cleanup - Phase 2.3 testing framework created (5 test scenarios) ## Phase 3 Planning 📋 DESIGN COMPLETE - Labeling consolidation ready for implementation: - Created PHASE_3_LABELING_CONSOLIDATION_PLAN.md - Scope: Consolidate 3 labeling workflows → 1 unified system - Design: 5 conditional jobs with clear event-driven separation - Effort: 12 hours estimated (implementation + testing + cleanup) ## Project Updates - Updated PROJECT_INDEX.md with Phase 2/3 status - Created PHASE_2_COMPLETION_SUMMARY.md (full Phase 2 retrospective) - Created PHASE_2_3_INTEGRATION_TESTING.md (testing framework + 5 scenarios) - Updated status tables and documentation references ## Test Results - ESLint/Prettier: ✅ Passed - GitHub Actions validation: ✅ Passed - Template enforcement: ✅ Passed - Branch naming: ✅ Compliant - All PR checklists: ✅ Complete Related: Epic #1227 (GitHub Workflows Consolidation Initiative) Issues: #1307 (✅), #1308 (✅), #1309 (🟡), #1310 (✅), #1311 (✅) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
This PR tests the regenerate job's dry-run mode on PR creation. Expected: regenerate job runs, no commits added to branch, artifacts uploaded. Scenario: test/phase-2-3-scenario-1-pr-dry-run Phase 2.3 Integration Testing
This commit tests the regenerate job's auto-commit mode on push to develop. Expected: regenerate job runs, README files regenerated, commit added automatically. Scenario: test/phase-2-3-scenario-2-push-commit Phase 2.3 Integration Testing
Contributor
Warning Review limit reached
Next review available in:58 seconds Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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 configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (13)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
## Phase 2.3 Testing Execution Summary ✅ Testing Framework: Complete 🟡 Test Execution: Live (5/5 scenarios running on GitHub Actions) ## Test Scenarios Triggered: 1. **Scenario 1 (PR dry-run)** — PR #1365 - Branch: test/phase-2-3-scenario-1-pr-dry-run - Change: README modification - Expected: regenerate job runs dry-run, no commits 2. **Scenario 2 (Push commit)** — PR #1366 - Branch: test/phase-2-3-scenario-2-push-commit - Change: README modification - Expected: regenerate job auto-commits changes 3. **Scenario 3 (Audit dispatch)** — Run #30105991164 - Trigger: workflow_dispatch with action=audit, scope=all - Expected: All 5 validation jobs run (syntax, accessibility, contrast, staleness, outcomes) 4. **Scenario 4A (Maintain dry-run)** — Run #30106000420 - Trigger: workflow_dispatch with action=maintain, dry_run=true - Expected: Mermaid/staleness updates previewed, no commits 5. **Scenario 4B (Maintain commit)** — Run #30106002628 - Trigger: workflow_dispatch with action=maintain, dry_run=false - Expected: Mermaid/staleness updates committed 6. **Scenario 5 (Conditional jobs)** — Verified across scenarios 1-4 - Expected: Correct jobs run based on event type ## Test Artifacts All test branches and PRs created: - test/phase-2-3-scenario-1-pr-dry-run - test/phase-2-3-scenario-2-push-commit - Workflow dispatch runs triggered for audit and maintain jobs ## Live Monitoring Watch execution progress: 1. GitHub Actions tab: Actions > Documentation Validation & Maintenance 2. PR #1365 and #1366 check status 3. Workflow run links in PHASE_2_3_INTEGRATION_TESTING.md Results will be documented as workflows complete (~1-5 minutes). Related: Epic #1227, Issues #1309 (Phase 2.3), #1310 (Phase 2.4) Phase: 2.3 Integration Testing (Live Execution) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
ashleyshaw
commented
Jul 24, 2026
MemberAuthor
Closing: Created from wrong base branch. Will recreate from develop after PR #1317 merge. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Phase 2.3 Integration Testing - Scenario 2
Test branch for documentation.yml regenerate job auto-commit mode on push.
Expected Behavior:
Verify:
Branch: test/phase-2-3-scenario-2-push-commit
Phase: 2.3 Integration Testing