Repository navigation
ci: changelog - Complete validation and merge gates #1273
Description
Phase 3: Rules & Guidelines Definition
Status: Partially Complete (Awaiting Phase 2 Completion)
Objective
Create authoritative rules for what belongs in CHANGELOG.md and how to format entries. Make validation automatic and enforceable in CI.
Completed Work (In PR #1281)
- ✅ CHANGELOG_GUIDELINES.md (465 lines) — Comprehensive format rules
- Entry format specification with examples
- Per-section guidance (Added, Fixed, Changed, etc.)
- Length limits & validation rules
- Common mistakes & fixes
- ✅ CHANGELOG_CONTRIBUTOR_CHECKLIST.md — Pre-submission checklist
- 5-section contributor guide
- Good/bad entry examples
- Step-by-step verification
- ✅ scripts/validation/changelog-rules.cjs (368 lines) — Format validation
- 7 validation rules (title length, em-dash, PR link, etc.)
- Integrated into CI pipeline
- npm run validate:changelog
- ✅ Integration tests — Phase 1 fix verification
- 3 test scenarios covering section header preservation
- Duplicate entry detection
- Entry format consistency
- ✅ CI Workflow Enhancement (.github/workflows/changelog-validate.yml)
- Format validation on every CHANGELOG PR
- Integration tests on every merge
- Section header verification
Remaining Work (Gaps #6-10)
HIGH PRIORITY:
- #6: Integrate checklist into PR template (1-2h)
- #7: Create measurable success metrics script (2-3h)
- #8: Complete remaining validation rules (3-4h)
MEDIUM PRIORITY:
Deliverables Ready for Deployment
Blockers
- Phase 2 completion (PR #1281 merge) — gates Phase 3 kickoff
Next Steps
- Merge PR #1281 to complete Phase 2
- Address HIGH-priority gaps #6-8
- Create measurable success metrics
- Finalize Phase 3 work
Related: Epic #1271, Phase 2 #1272, Phase 1 #1275
Definition of Ready (DoR)
- Clear problem statement and expected outcome
- Acceptance criteria defined
- Related issues/dependencies identified
- Required resources/approvals listed
- Build/CI goal and scope defined
- Checklist prepared
- Estimate added
Definition of Done (DoD)
- All acceptance criteria met
- Changes tested and validated
- Documentation updated
- Changes merged and deployed
- Stakeholders notified
Metadata
Metadata
Assignees
Type
Fields
Priority
None yet
Activity
linear-code commentedon Jul 24, 2026
LS-1823
github-actions commentedon Jul 24, 2026
⏱️ Aging and SLA annotation
Maintained by project-meta-sync workflow.
github-actions commentedon Jul 24, 2026
Missing required section(s): Definition of Ready (DoR), Definition of Done (DoD)
The issue will remain open and flagged until the body is corrected.
Please update the issue with one of the official templates:
If this was opened by automation, update the automation to preserve the template sections before creating the issue.
ashleyshaw commentedon Jul 24, 2026
Phase 3 Planning Complete
Phase 3 (Validation & Merge) is fully documented and awaiting Phase 2 completion:
📋 Project Plan: PROJECT_PLAN.md — Phase 3 Section
Phase 3 Deliverables:
Blocking: This phase starts after Phase 2 completes (rebuild of lost history)
Dependencies:
Reference Guidelines: CHANGELOG_GUIDELINES.md
docs(changelog): comprehensive automation hardening plan & execution …
fix(changelog): preserve section headers & establish automation harde…
[-]Changelog Phase 3: Validation & Merge[/-][+]ci: changelog - Complete validation and merge gates[/+]