Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 25 additions & 12 deletions .github/ISSUE_TEMPLATE/18-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,43 @@
file_type: "issue-template"
name: "🚀 Release"
about: "Propose or track release management, versioning, or deployment tasks."
version: "1.0.2"
version: "1.1.0"
last_updated: "2026-06-19"
category: "github-templates"
---

## Release Summary

<!-- Briefly describe the release, deployment, or versioning event. -->
<!-- Briefly describe the release: version, scope (patch/minor/major), and key themes. -->

## Full Changelog Entry Summary

<!-- Summarise the [Unreleased] entries that will be promoted in this release. -->

## Milestones / Checklist

<!-- List key steps, milestones, or tasks for this release. -->
<!-- The release flow is: develop → release/vX.Y.Z → main
All feature/fix/chore branches merge to develop.
The release branch is created FROM develop and its PR targets main. -->

- [ ] Release goal described
- [ ] Versions/tags mapped
- [ ] Docs/changelog prepared
- [ ] Release notes drafted
- [ ] QA/staging verified
- [ ] All in-flight PRs confirmed merged to `develop`
- [ ] `CHANGELOG.md` unreleased entries reviewed and finalised
- [ ] `[X.Y.Z]` section cut in `CHANGELOG.md` with release date
- [ ] Release branch `release/vX.Y.Z` created **from** `develop`
- [ ] `release/vX.Y.Z` PR opened **against** `main` using `pr_release.md` template
- [ ] CI green on release PR
- [ ] Release PR reviewed and approved
- [ ] Release PR merged → `main`; tag `vX.Y.Z` created

## Acceptance Criteria

<!-- List requirements for completion. Use checkboxes. -->

- [ ] Release completed and verified
- [ ] Documentation/changelog updated
- [ ] Release notes published
- [ ] `CHANGELOG.md` section published with full entry list
- [ ] Release tag `vX.Y.Z` exists on `main`
- [ ] GitHub Release published with compiled notes
- [ ] `develop` synced with `main` after merge (no drift)

## Additional Context

Expand All @@ -39,12 +50,14 @@ category: "github-templates"

- [ ] Release goal and scope defined
- [ ] Milestones and checklist mapped
- [ ] Estimate added
- [ ] All changelog entries catalogued
- [ ] Open PRs identified for pre-tag merge

## Definition of Done (DoD)

- [ ] All checklist and acceptance criteria completed
- [ ] Documentation/changelog updated
- [ ] CHANGELOG section published
- [ ] Release tag on `main`
- [ ] Approved by maintainer

---
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- **Mermaid WCAG 2.2 AA colour contrast validation** — Added `scripts/validation/validate-mermaid-colour-contrast.js` which checks every `style` declaration in Mermaid diagrams against a pre-verified WCAG 2.2 AA palette (minimum 4.5:1 contrast ratio). The validator supports `--changed-files` scoping for CI efficiency, flags unparseable hex values as errors, strips inline `%%` comments before parsing, and generates a dated markdown report under `.github/reports/mermaid/`. Added `npm run validate:mermaid-contrast` script. Updated `.github/workflows/validate-mermaid-pr.yml` to run all three diagram checks (syntax, accessibility, contrast) on every PR that modifies `.md`/`.mdx` files, posting a consolidated status comment. Updated `instructions/mermaid.instructions.md` with the approved seven-role WCAG AA palette and required structure. Fixed all existing diagram `style` declarations across `README.md`, `docs/AGENT_CREATION.md`, `profile/README.md`, `scripts/README.md`, `tests/README.md`, and `.github/ISSUE_TEMPLATE/README.md` to use the approved palette triples (`fill`, `color`, `stroke`). ([#977](https://github.com/lightspeedwp/.github/pull/977), [#976](https://github.com/lightspeedwp/.github/issues/976))

### Fixed

- **Release agent hardening** — Fixed four bugs in `scripts/agents/release.agent.js`: (1) regex escape `\\d+` → `\d+` in `getMergedPRs` so PR numbers are correctly extracted from `git log`; (2) automated release PR body now includes all three sections (`## Linked issues & merged PRs`, `## Changelog`, `### Checklist (Global DoD / PR)`) required by the main-branch-guard; (3) `createReleasePR` (shell provider) now writes the body to a temp file and uses `--body-file` to avoid shell injection from backtick-containing markdown; (4) corrected Husky v9 command from `npx husky run pre-commit` to `npx lint-staged`. Added full test suites for `changelogUtils.cjs`, `validate-main-branch-pr.cjs`, and `release.agent.js` (ESM subprocess pattern); rewrote the stub in `validate-changelog.test.js` with real CLI and integration tests. Clarified the `develop → release/vX.Y.Z → main` flow in the release issue template. ([#1018](https://github.com/lightspeedwp/.github/pull/1018), [#968](https://github.com/lightspeedwp/.github/issues/968))

### Changed

- **Frontmatter standardisation across issue templates, docs, and validation** — Normalised markdown issue templates to use `name` + `about`, aligned the frontmatter schema and validation scripts with the GitHub-supported template contract, and updated the issue-creation workflow plus related docs, instructions, and prompts to match the canonical template layout. ([#1016](https://github.com/lightspeedwp/.github/pull/1016), [#1012](https://github.com/lightspeedwp/.github/issues/1012), [#1015](https://github.com/lightspeedwp/.github/issues/1015))
Expand Down
Loading
Loading