5.9 KiB
5.9 KiB
2026-01 release entry template
Release summary
- Release window: 2026-01
- Planned version/tag: To be assigned when the release is cut.
- SemVer decision: Patch, minor, or major must be selected according to docs/versioning.md before tagging. Use major for breaking changes, minor for backward-compatible additions or deprecations, and patch for backward-compatible fixes or documentation corrections.
- Changelog source: Align this entry with CHANGELOG.md before release cut.
- Upgrade guidance: Confirm affected operators can follow docs/upgrade.md and the detailed upgrade runbook.
Changelog alignment
Added
- No changes recorded yet for this category.
Changed
- No changes recorded yet for this category.
Deprecated
- No deprecations recorded yet for this category.
Removed
- No removals recorded yet for this category.
Fixed
- No fixes recorded yet for this category.
Security
- No security-specific changes recorded yet for this category.
Pre-release checklist
- Release scope matches the relevant
CHANGELOG.mdentry and all Keep a Changelog categories are complete. - SemVer decision is documented and reviewed against
docs/versioning.md. - Upgrade, migration, and rollback notes are documented for deployability, data, configuration, provider, and security-affecting changes.
- Documentation links were checked and no unresolved local links or unresolved marker text remain.
- Secrets, credentials, tenant identifiers, customer data, provider payloads, screenshots, and production connection strings are redacted from release evidence.
- Manual runtime checks are identified with owner, environment, expected evidence, and stopping criteria.
Release-cut checklist
- Version or release window is final.
- Artifact/tag evidence is recorded with immutable references where available.
CHANGELOG.mdhas the matching release notes and date.- Release notes call out breaking changes, migrations, deprecations, and security fixes when present.
- Supported automated verification commands completed or failures are documented with owner and follow-up.
- Manual checks are not represented as automated verification.
Post-release checklist
- Published artifact, tag, or deployment reference was confirmed by the release owner.
- Support, operations, and maintainer handoff notes were updated.
- Rollback readiness was reviewed after release cut.
- Post-release monitoring or manual runtime checks were recorded with redacted outcomes.
- Follow-up defects, documentation corrections, and migration work were linked from the release record.
Verification evidence
Record supported non-E2E automated verification here. Use only repository-supported commands such as:
pnpm run typecheck
pnpm run lint
pnpm run verify:release-docs-baseline
pnpm run verify:docs-links
pnpm exec vitest run scripts/verify-release-docs-baseline.test.mjs
| Command | Owner | Date | Result | Notes |
|---|---|---|---|---|
pnpm run verify:docs-links |
Pending assignment | Pending assignment | Pending | Required before release closure. |
pnpm run verify:release-docs-baseline |
Pending assignment | Pending assignment | Pending | Confirms release-checklist, changelog, artifact/tag, and production-readiness inventory terms. |
pnpm exec vitest run scripts/verify-release-docs-baseline.test.mjs |
Pending assignment | Pending assignment | Pending | Focused baseline-gate regression check. |
Artifact/tag evidence
| Evidence type | Value | Owner | Date | Redaction notes |
|---|---|---|---|---|
| Release tag | Pending assignment | Pending assignment | Pending assignment | Use immutable tag only; no credentials. |
| Commit SHA | Pending assignment | Pending assignment | Pending assignment | Use reviewed commit SHA. |
| Build artifact or image digest | Pending assignment | Pending assignment | Pending assignment | Use immutable digest or build ID; no registry credentials. |
| Release notes URL or ID | Pending assignment | Pending assignment | Pending assignment | Public or internal URL must not expose tokens. |
Rollback notes
- Rollback type: Mark as redeploy-only, migration-sensitive, backup-dependent, or unsupported after release scope is known.
- Previous known-good artifact: Pending assignment.
- Database or migration impact: Pending assignment; if migrations are involved, confirm backup or restore-point readiness before production deployment.
- Operational stopping point: Stop before live deployment, provider change, or irreversible migration if required evidence is missing.
- Redaction rule: Rollback notes may include target name, tag, reviewed version, status, request ID, job ID, and redacted diagnostic code only.
Manual checks
Manual checks are required for browser, Playwright, Cypress, E2E, production deploy, live Docker, live registry, Coolify, provider-console, or other runtime-only activities. Do not list these as automated checks.
| Manual check | Owner | Environment | Result | Redacted evidence |
|---|---|---|---|---|
| Browser smoke journey | Pending assignment | Pending assignment | Pending | Record route and outcome only; no cookies or screenshots with customer data. |
| Production deployment or Coolify review | Pending assignment | Pending assignment | Pending | Record immutable artifact/tag and redacted health outcome. |
| Provider-console or live registry review | Pending assignment | Pending assignment | Pending | Record status and request/reference ID only; no provider payloads or credentials. |
Negative verification expectations
Release verification must reject missing release files, unresolved local links, and unresolved marker text. Release entries must not rely on unsupported commands or claim automatic browser, Playwright, Cypress, registry, provider-console, production deploy, or E2E execution.