0 Fork 0

mirror of https://github.com/cozystack/cozystack.git synced 2026-10-30 08:37:31 +09:00

Files

T

Myasnikov Daniil 717c8860f6 docs(release): make the release playbook coherent with the promote flow

Final coherence pass over docs/release.md (and the releasing.md
pointer) after several incremental patches to the release-cycle
rework left the whole-document narrative uneven.

- Rewrite the regular and patch release sequences so a maintainer
  reading top-to-bottom performs the actual flow: cut rc -> watch
  mandatory rc E2E -> [optional Generate RC Changelog button] ->
  promote dispatch (E2E gate; changelog generated or picked up;
  website docs PR opened and parked) -> review the promote PR (no
  E2E by default; E2E/changelog/website-docs lines) -> merge ->
  finalize -> merge the parked website PR, then announce.
- Purge the last old-model sentence: "vX.Y.0 is tagged from the
  last RC or a later commit in main" -> promoted from the rc by
  digest, tag cut write-once at the promote PR merge commit.
- State the alpha/beta contract where prereleases are discussed:
  built and published, button-only E2E (no mandatory rc-e2e), and
  no promotion path (promote-rc accepts vX.Y.Z-rc.N alone).
- Fix the Phase 4 heading (was "chore(release): cut vX.Y.Z"; the
  PR is "chore(release): promote ... -> ...") and add the missing
  website-docs line to the reviewer checklist; add a
  keep-parked-until-publish item to the pre-release checklist.
- Add cut-prerelease.yaml, changelog-rc.yaml, and
  changelog-generate.yaml to "See also" so the workflow inventory
  is complete and consistent with the "seven workflows + reusable
  changelog-generate" count.
- releasing.md: replace the stale "typically involves ... creating
  git tags / building artifacts" list (invalidated by the
  promote-not-rebuild model) with the real high-level sequence.

Every workflow/job/step name cited was verified against the YAML on
this branch. hack/release-changelog-contract.bats stays green (24/24);
no test pins docs/release.md strings, so no test change was needed.

Assisted-By: Claude <noreply@anthropic.com>
Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>

2026-07-24 18:16:26 +05:00

1.2 KiB

Raw Blame History

Release Process

This document provides instructions for AI agents on how to handle release-related tasks.

When to Use

Follow these instructions when the user asks to:

Create a new release
Prepare a release
Tag a release
Perform release-related tasks

Instructions

For detailed release process instructions, follow the steps documented in:

docs/release.md

Quick Reference

The release process is promotion-based — a stable release is a renamed release-candidate, never a hand-cut tag or a rebuild. At a high level it involves:

Cutting a release candidate (Cut Pre-release Tag workflow) and watching its mandatory full E2E.
Promoting the rc (Promote RC workflow), which generates the changelog, opens the parked cozystack/website docs PR, and opens the promote PR.
Reviewing and merging the promote PR (no squash-merge).
Finalize on merge (CI cuts the write-once tag, publishes the release from the merged changelog, and retags the rc images to stable by digest).
Merging the parked website docs PR once the release is published.

All detailed steps, workflows, and failure modes are documented in docs/release.md.

1.2 KiB Raw Blame History

Release Process

When to Use

Instructions

Quick Reference

1.2 KiB

Raw Blame History