Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update RELEASE_CHECKLIST.md to reflect state of operations #4841

Merged
merged 1 commit into from
Mar 25, 2024

Conversation

abernix
Copy link
Member

@abernix abernix commented Mar 25, 2024

Wrote up these changes on Friday night and just wanted to push them up. The overall mechanisms haven't changed (e.g., a tag creates a release), but these are steps which have changed, process-wise in terms of how we do releases. Today, we've adopted the pattern of:

  1. Open a Release Branch from a point in time with specific intention to land certain features for a specific milestone we're working toward (e.g., Subscription WebSocket fixes in the last release). This PR targets main, but stays as draft until it's ready to go final (step 4)
  2. Stage changes and final polish on that Release branch and associated PR while the rest of dev moves forward.
  3. Cut any number of release candidates for testing and validation. These release candidates don't get the full-changelog treatment.
  4. Finalize the release through the previous pattern of merging that initial PR into main.

Concretely, the release checklist steps are no longer all grouped into one "big step" and no longer require you to remember where to pick up. Instead, each have distinct sections which can either be done at separate times (and by separate people!) or just all at once.

There are a lot of steps, but aside from setting the required variables at each stage, it's copy-paste all the way down (but a lot of copy-paste, admitedly).

There are some clear follow-up items still - all of them include automation - but I don't think we should wait for them.

The overall mechanisms haven't changed, but these are steps which have changed, process-wise in terms of how we do releases.

Aside from setting the variables at each stage, it's basically copy-paste all the way down (but a lot of copy-paste).

Concretely, the steps are no longer all grouped into one and no longer you
to remember where to pick up, or require manual changes to do things like
cut pre-releases.  Instead, each have distinct sections which can either be
done at separate times (and by separate people!) or just all at once.
Copy link
Contributor

@abernix, please consider creating a changeset entry in /.changesets/. These instructions describe the process and tooling.

@abernix abernix requested review from BrynCooke and Geal March 25, 2024 07:49
@abernix abernix enabled auto-merge (squash) March 25, 2024 08:40
@abernix abernix merged commit 72cfc47 into dev Mar 25, 2024
15 checks passed
@abernix abernix deleted the abernix/release-checklist-2024 branch March 25, 2024 13:48
@abernix abernix added release and removed release labels May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants