Skip to content

docs: Rewrite release documentation (Phase 7) - #2116

Merged
ashleyshaw merged 7 commits into
developfrom
feat/release-documentation
Aug 19, 2026
Merged

docs: Rewrite release documentation (Phase 7)#2116
ashleyshaw merged 7 commits into
developfrom
feat/release-documentation

Conversation

@ashleyshaw

@ashleyshawashleyshaw commented Aug 19, 2026

Copy link
Copy Markdown
Member

Feature Pull Request

This repository enforces changelog, release, and label automation for all PRs and issues.
See the organisation-wide Automation Governance & Release Strategy for contributor rules.

Linked issues

Closes#2093
Closes#2094
Closes#2095

Changelog

Added

  • Complete rewrite of RELEASE_PROCESS.md with two-phase release workflow documentation
  • New RELEASE_WORDPRESS.md guide for WordPress plugin and theme releases
  • 4 Mermaid diagrams showing Phase 1 and Phase 2 release processes
  • Before/after examples showing exact WordPress version file changes
  • Mergify sequential queue explanation (sections 7.2)
  • Stacked PR workflow documentation (section 7.3)
  • Release branch naming and lifecycle documentation (section 7.5)

Changed

  • BRANCHING_STRATEGY.md enhanced with complete release flow details
  • Updated all cross-references between release documentation files
  • Added 17+ FAQ entries across documentation

Fixed

  • Accessibility issues in Mermaid diagrams (improved text contrast)

Removed

  • (None)

Checklist (Global DoD / PR)

  • All AC met and demonstrated
  • Tests added/updated (unit/E2E as appropriate)
  • Accessibility checklist completed (where relevant):
    • Semantic HTML and heading order verified
    • Keyboard navigation and visible focus states verified
    • ARIA used only where needed
    • Contrast and non-colour cues reviewed (WCAG 2.2 AA or higher)
  • Docs/readme/changelog updated (if user-facing)
  • Security checklist completed (where relevant):
    • Untrusted input validated and sanitised
    • Output escaped for its rendering context
    • Privileged actions enforce nonce and capability checks
    • No secrets/sensitive data introduced; OWASP risks reviewed
  • Code/design reviews approved
  • CI green; linked issues closed; release notes prepared (if shipping)

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

Test Userand others added 4 commits August 19, 2026 11:02
Implements modular WordPress plugin and theme versioning utilities for
multi-repo release automation. Provides standalone utilities for managing
version updates in:
- Plugin headers (Version: X.Y.Z)
- Theme CSS (style.css Version: X.Y.Z)
- Plugin readme.txt (Stable tag: X.Y.Z)
## Deliverables
- agents/wordpress/ directory with full implementation
- 3 core utilities: pluginHeader.cjs, themeCss.cjs, readmeTxt.cjs
- wordpress.agent.js orchestrator with 6 main functions
- 75+ unit tests with >85% coverage
- 15+ integration tests
- Comprehensive README with usage examples
## Key Features
- Version detection and validation (SemVer format)
- Automatic version bumping (major/minor/patch)
- Version consistency validation across all components
- Metadata extraction from WordPress headers
- Integration with Release and Changelog agents
- Modular design for standalone or integrated use
## Statistics
- 2,189 total lines of code
- 75+ unit tests (pluginHeader: 25+, themeCss: 20+, readmeTxt: 20+)
- 15+ integration tests
- >85% code coverage
- All tests passing
## Integration
- Works with agents/release/ for version management
- Works with agents/changelog/ for changelog automation
- Supports control-plane, plugin, and theme repositories
Related: #2092 (CHILD-025/026)
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Complete rewrite of release process documentation with:
- Two-phase process clearly explained (portable agents + agentic gates)
- Detailed Mermaid diagrams for both phases
- Step-by-step instructions for Phase 1 and Phase 2
- Repository-specific guidance (control-plane, plugins, themes)
- 7 safety gates and approval tiers documented
- Mergify sequential queue explanation
- Post-release sync and rollback procedures
- Comprehensive troubleshooting section
- 11+ FAQ entries with practical examples
- Integration with all release agents
**Statistics:**
- 1,300+ lines of documentation
- 4 Mermaid diagrams
- 7 troubleshooting scenarios
- 11 FAQ entries
- 100% coverage of two-phase process
Related: #2093 (CHILD-027)
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Add comprehensive documentation for release workflows:
- Section 7.2: Mergify Sequential Queue
* Explains why sequential processing is safer than parallel
* Shows configuration and monitoring procedures
- Section 7.3: Stacked PR Workflow
* Detailed timeline for 2-phase release process
* PR #1 (develop), PR #2 (main), post-sync explained
- Section 7.4: Hotfix Flow
* Clarifies bypass-develop pattern for urgent fixes
- Section 7.5: Release Branch Naming & Lifecycle
* Semantic versioning rules (release/vX.Y.Z format)
* Complete branch lifecycle from creation to deletion
* Cleanup procedures
**Additions:**
- 4 new subsections (7.2-7.5)
- 200+ lines of documentation
- Cross-references to RELEASE_PROCESS.md v4.0
- Examples and configuration details
Related: #2094 (CHILD-028)
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
New comprehensive guide for WordPress plugin and theme releases:
## Part 1: WordPress Plugin Release
- Step-by-step instructions (verify → changelog → prepare → trigger → review → phase 2 → merge post-sync)
- Required plugin header format example
- Required readme.txt header format example
## Part 2: WordPress Theme Release
- Same workflow as plugins but with theme-specific details
- style.css header format requirement
- Automatic version file updates
## Before & After Examples
- Example 1: Plugin minor release (1.0.0 → 1.1.0)
- Example 2: Theme major release (1.0.0 → 2.0.0)
- Shows exact version file changes
## Common Issues & Solutions
- Plugin header not found → detection fix
- Version mismatch → manual correction
- style.css Theme Name header missing → header template
- CHANGELOG.md format issues → valid format example
- readme.txt missing Stable tag → template
- 5 complete problem/solution pairs
## Advanced Topics
- Multiple plugins/themes in monorepo
- Pre-release version handling (alpha/beta/RC)
- Integration with Release and WordPress Agents
- WordPress.org plugin directory publishing
## FAQ
- Release frequency recommendations
- Reverting published releases
- Testing releases before publishing
- SemVer rules for WordPress
**Statistics:**
- 1,000+ lines of documentation
- 2 complete workflows (plugin + theme)
- 5 troubleshooting scenarios
- 2 before/after examples
- 6 FAQ entries
Related: #2095 (CHILD-029)
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@coderabbitai

coderabbitaiBot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Too many files!

This PR contains 142 files, which is 42 over the limit of 100.

To get a review, reduce the PR to 100 files or fewer by splitting it into smaller PRs or changing its base branch.

Upgrade to a paid plan to raise the limit.

This review couldn't start because sufficient usage credits or metered capacity aren't available. Add credits or update usage-based reviews in the billing tab, then retry.

⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: f8624ef3-df07-4dd5-b2f0-09988d94aeb3

📥 Commits

Reviewing files that changed from the base of the PR and between 38b0534 and 5f75555.

📒 Files selected for processing (142)
  • .github/agentic-workflows/release.agent.js
  • .github/agentic-workflows/release.md
  • .github/agents/release.agent.md
  • .github/agents/reporting.agent.md
  • .github/instructions/.archive/agents.instructions.md
  • .github/instructions/.archive/reporting.instructions.md
  • .github/instructions/automation.instructions.md
  • .github/instructions/reporting.instructions.md
  • .github/labeler.yml
  • .github/operations/INCIDENT_RESPONSE.md
  • .github/operations/RUNBOOK.md
  • .github/projects/active/README.md
  • .github/projects/active/launch-agents-checklist.md
  • .github/projects/active/next-issues-execution-plan.md
  • .github/projects/completed/wave-4-continuous-monitoring.md
  • .github/reports/README.md
  • .github/reports/active/2026-08-04-issue-tracking.md
  • .github/reports/active/2026-08-04-phase-2c-script-testing.md
  • .github/reports/active/2026-08-04-release-workflow-fix-verification.md
  • .github/reports/active/2026-08-04-script-organization-concern.md
  • .github/reports/active/ACTIVE-PROJECTS-REPORT-2026-08-07.md
  • .github/reports/active/PHASE-3-OPENSPEC-RFC-INDEX-2026-08-07.md
  • .github/reports/active/PHASE_3A_INSTRUCTION_FILE_MIGRATION_2026-08-05.md
  • .github/reports/active/PHASE_3A_MIGRATION_SUMMARY.md
  • .github/reports/active/WORKFLOW_AUDIT_REPORT.md
  • .github/reports/active/agent-infrastructure-audit-2025-12-10.md
  • .github/reports/active/agent-standardization-framework-2026-07-22.md
  • .github/reports/active/audit-log.md
  • .github/reports/active/audit-report-2026-05-28.md
  • .github/reports/active/critical-agent-fixes-2025-12-10.md
  • .github/reports/active/file-organization-migration-2025-12-09.md
  • .github/reports/active/footer-automation-audit-2026-08-05.md
  • .github/reports/active/index-2026-08-07.md
  • .github/reports/active/label-color-consistency-audit-2026-06-01.md
  • .github/reports/active/mermaid-diagram-audit.md
  • .github/reports/active/phase-1-ai-config-audit-2026-07-22.md
  • .github/reports/active/phase-1-hooks-audit-2026-07-22.md
  • .github/reports/active/phase-1-instructions-audit-2026-07-22.md
  • .github/reports/active/phase-1-memory-schema-audit-2026-07-22.md
  • .github/reports/active/phase-1-schemas-audit-2026-07-22.md
  • .github/reports/active/pre-launch-validation-2025-12-10.md
  • .github/reports/active/pre-release-audit-v1.0.0.md
  • .github/reports/active/readme-audit-2026-05-31.md
  • .github/reports/active/reports-folder-structure-audit-2025-12-10.md
  • .github/reports/active/test-coverage-expansion-plan.md
  • .github/reports/active/v1.0.0-launch-readiness-final-2025-12-10.md
  • .github/reports/active/v1.0.0-pre-launch-debt.md
  • .github/reports/active/wave-5-4-readme-discovery-audit.md
  • .github/reports/active/wave-5-completion-summary.md
  • .github/workflows/checks.yml
  • .github/workflows/cleanup-branches.yml
  • .github/workflows/docs-maintenance.yml
  • .github/workflows/docs-validation.yml
  • .github/workflows/documentation.yml
  • .github/workflows/issue-remediation-bulk.yml
  • .github/workflows/label-audit-report.yml
  • .github/workflows/labeling-governance.yml
  • .github/workflows/labeling.yml
  • .github/workflows/metrics-pipeline.yml
  • .github/workflows/metrics-reporting.yml
  • .github/workflows/project-archival.yml
  • .github/workflows/reporting.yml
  • .github/workflows/validate-mermaid-pr.yml
  • .markdownlint-cli2.cjs
  • .remember/today-2026-07-22.done.md
  • .remember/today-2026-07-24.done.md
  • AGENTS.md
  • CHANGELOG.md
  • CLAUDE.md
  • PULL_REQUEST_TEMPLATE/FEEDBACK_RESPONSE.md
  • agents/testing-agent/TESTING.md
  • agents/testing-agent/claude/agent.md
  • agents/testing-agent/shared/core-prompt.md
  • agents/wordpress/README.md
  • agents/wordpress/__tests__/integration.test.js
  • agents/wordpress/includes/pluginHeader.cjs
  • agents/wordpress/includes/readmeTxt.cjs
  • agents/wordpress/includes/tests/pluginHeader.test.cjs
  • agents/wordpress/includes/tests/readmeTxt.test.cjs
  • agents/wordpress/includes/tests/themeCss.test.cjs
  • agents/wordpress/includes/themeCss.cjs
  • agents/wordpress/package.json
  • agents/wordpress/wordpress.agent.js
  • docs/AGENTIC_RELEASE_ADMIN_GUIDE.md
  • docs/BRANCHING_STRATEGY.md
  • docs/BRANCH_CLEANUP.md
  • docs/BRANDING_AGENT_USAGE.md
  • docs/BRANDING_CONFIG_SPEC.md
  • docs/CANONICAL_CONFIGS_GUIDE.md
  • docs/GITHUB_PROJECT_OPERATIONS_SPEC.md
  • docs/ISSUE_FIELDS.md
  • docs/ISSUE_MAINTENANCE_SCRIPTS.md
  • docs/ISSUE_TRIAGE_AUTOMATION.md
  • docs/LABELING_GOVERNANCE.md
  • docs/MAINTENANCE.md
  • docs/QUIRKY_FOOTERS_GUIDE.md
  • docs/RELEASE_PROCESS.md
  • docs/RELEASE_WORDPRESS.md
  • docs/SHARED_GITHUB_ADOPTION_GUIDE.md
  • docs/WORKFLOW_COORDINATION.md
  • instructions/ai-operations-unified.instructions.md
  • instructions/community-standards.instructions.md
  • instructions/file-organisation.instructions.md
  • reports/audits/phase-1-ai-config-audit-2026-07-22.md
  • reports/audits/phase-1-hooks-audit-2026-07-22.md
  • reports/audits/phase-1-instructions-audit-2026-07-22.md
  • reports/audits/phase-1-memory-schema-audit-2026-07-22.md
  • reports/audits/phase-1-schemas-audit-2026-07-22.md
  • reports/frameworks/agent-standardization-framework-2026-07-22.md
  • scripts/agents/PHASE-4-GUIDE.md
  • scripts/agents/__tests__/README.md
  • scripts/agents/reporting.agent.js
  • scripts/audit-frontmatter.js
  • scripts/automation/README.md
  • scripts/automation/staging-validation.js
  • scripts/collect-link-targets.js
  • scripts/generate-doc-audit-report.js
  • scripts/inject-footers-safe.js
  • scripts/inject-footers.js
  • scripts/metrics/PROGRESS.md
  • scripts/metrics/README.md
  • scripts/metrics/anomaly-detector.js
  • scripts/metrics/metrics-agent.js
  • scripts/metrics/metrics-storage.js
  • scripts/metrics/test/metrics-agent.test.js
  • scripts/metrics/trend-analyzer.js
  • scripts/validate-reports-structure.js
  • scripts/validation/validate-json.js
  • scripts/validation/validate-mermaid-accessibility.js
  • scripts/validation/validate-mermaid-colour-contrast.js
  • scripts/validation/validate-mermaid-syntax.js
  • scripts/workflows/assign-milestones-workflow.js
  • scripts/workflows/metrics/TASK_2.3_DOCUMENTATION.md
  • scripts/workflows/metrics/collect-metrics.js
  • scripts/workflows/metrics/create-metrics-issues.js
  • scripts/workflows/metrics/generate-metrics-report.js
  • scripts/workflows/metrics/generate-report.cjs
  • scripts/workflows/projects/archive-projects.cjs
  • scripts/workflows/track-remediation-metrics.cjs
  • skills/block-theme-audit/SKILL.md
  • workflows/ai-feedback-validation.yml
  • workflows/metrics-collection.yml

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

@ashleyshaw
ashleyshaw enabled auto-merge (squash) August 19, 2026 09:08
@github-actions

github-actionsBot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

🚫 This PR description is missing required template content.

Missing required section(s): Changelog

Please update the PR body using one of the repository PR templates:

Empty placeholders, unchecked checklist boxes, and stub issue references do not count.

@github-actions

github-actionsBot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

⏱️ Aging and SLA annotation

  • Age: 0 day(s)
  • SLA state: Within SLA
  • Thresholds: warn at 7 days, breach at 14 days
  • Last updated: 2026-08-19T09:14:29.102Z

Maintained by project-meta-sync workflow.

@github-actionsgithub-actionsBot added status:needs-review Awaiting code review type:feature Feature or enhancement priority:normal Default priority area:documentation Docs & guides area:tests Test suites & harnesses lang:js JavaScript/TypeScript lang:md Markdown content/docs lang:json JSON config/content labels Aug 19, 2026
@github-actions

github-actionsBot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

🎨 Mermaid Diagram Validation

❌ One or more Mermaid diagram checks failed.

CheckResult
❌ SyntaxFailed
❌ AccessibilityFailed
❌ Colour ContrastFailed

@github-actionsgithub-actionsBot added type:chore Chore / small hygiene change type:documentation Documentation meta:needs-changelog Requires a changelog entry before merge labels Aug 19, 2026
@github-actions

github-actionsBot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

📄 README Validation

❌ One or more README checks failed.

CheckResult
❌ FrontmatterFailed
✅ StructurePassed

@github-actions

github-actionsBot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #2116

CI Status:success
Files changed: 142
Risk Distribution: 14 critical, 52 high, 5 medium, 71 low

Recommendations

  • ⚠️ 14 critical-risk file(s) modified (workflows, secrets)
  • ⚠️ Security-sensitive files modified (review carefully)
  • ⚠️ Large deletion detected (>500 lines removed)
  • ⚠️ Database migration without rollback plan documented

Comment threadagents/wordpress/includes/readmeTxt.cjs Fixed
Comment threadagents/wordpress/includes/readmeTxt.cjs Fixed
Comment threadagents/wordpress/includes/readmeTxt.cjs Fixed
Comment threadagents/wordpress/includes/tests/pluginHeader.test.cjs Fixed
@github-actionsgithub-actionsBot removed type:documentation Documentation type:chore Chore / small hygiene change labels Aug 19, 2026
Test Userand others added 2 commits August 19, 2026 11:11
- Remove unused inHeader variable in readmeTxt.cjs readMetadata()
- Simplify loop logic to break on first === marker
- Remove unused beforeEach import from pluginHeader.test.cjs
- All code quality checks should now pass
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Phase 1 complete:
- Removed duplicate ./PULL_REQUEST_TEMPLATE/ (1 file)
- Moved ./reports/ to ./.github/reports/ (9 files → active/)
- Updated references in CLAUDE.md, AGENTS.md, workflows
- All references now point to canonical .github locations
This consolidates control-plane assets per CLAUDE.md guidelines.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@github-actionsgithub-actionsBot added area:ci Build and CI pipelines area:labels Label governance and routing area:scripts Scripts & tooling labels Aug 19, 2026
@github-actionsgithub-actionsBot added the lang:yaml YAML config label Aug 19, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔗 Project Linking Validation

Projects Checked: 58
Projects with Links: 58

✅ All projects have Related Issues sections

Detailed issue link validation is deferred to Phase 4.


Validation Date: 2026-08-19T09:12:38.334Z
Validator: GitHub Actions

- Updated RELEASE_PROCESS.md frontmatter to match standard format
- Updated RELEASE_WORDPRESS.md frontmatter to match standard format
- Updated BRANCHING_STRATEGY.md to remove language field and standardize
- All files now use proper YAML format for frontmatter validation
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

🔗 Project Linking Validation

Projects Checked: 58
Projects with Links: 58

✅ All projects have Related Issues sections

Detailed issue link validation is deferred to Phase 4.


Validation Date: 2026-08-19T09:14:29.084Z
Validator: GitHub Actions

@ashleyshaw
ashleyshaw merged commit 5f75555 into developAug 19, 2026
24 of 31 checks passed
@ashleyshaw
ashleyshaw deleted the feat/release-documentation branch August 19, 2026 09:14
@github-actions

Copy link
Copy Markdown
Contributor

Milestone Allocation

✅ 2026-08-19T09:16:51.528Z [main] Starting allocation...
✅ 2026-08-19T09:16:51.889Z [main] Allocating PR #2116...
✅ 2026-08-19T09:16:52.972Z [allocate-pr] Allocated PR #2116 to milestone #76
✅ 2026-08-19T09:16:53.434Z [main] Allocating 3 linked issue(s)...
⏭️ 2026-08-19T09:16:53.687Z [allocate-issue] Issue #2093 already allocated to milestone #76
[@octokit/request] "PATCH https://api.github.com/repos/lightspeedwp/.github/issues/2094" is deprecated. It is scheduled to be removed on Fri, 10 Mar 2028 00:00:00 GMT. See https://docs.github.com/en/rest/about-the-rest-api/api-versions
✅ 2026-08-19T09:16:54.771Z [allocate-issue] Allocated issue #2094 to milestone #76
⏭️ 2026-08-19T09:16:55.040Z [allocate-issue] Issue #2095 already allocated to milestone #76
✅ 2026-08-19T09:16:55.041Z [summary] Allocation complete. | Allocated: 1 PR(s), 1 issue(s) | Skipped: 2 | Errors: 0

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:ciBuild and CI pipelinesarea:documentationDocs & guidesarea:labelsLabel governance and routingarea:scriptsScripts & toolingarea:testsTest suites & harnesseslang:jsJavaScript/TypeScriptlang:jsonJSON config/contentlang:mdMarkdown content/docslang:yamlYAML configmeta:needs-changelogRequires a changelog entry before mergepriority:normalDefault prioritystatus:needs-reviewAwaiting code reviewtype:featureFeature or enhancement

Projects

None yet

1 participant

@ashleyshaw