Skip to content

Commit

Permalink
Add release checklist issue template; Document some of our timelines …
Browse files Browse the repository at this point in the history
…around releases (#1538)

* Add a spec release checklist issue template

because I'm tired of copy/paste

* Document a chunk of our release approach

This should probably go elsewhere, but here is fine for now as a SCT-referenced doc/content.

* changelog

* Brief clarifications
  • Loading branch information
turt2live authored May 25, 2023
1 parent 089d209 commit fbb8a78
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: [SCT] Release checklist
about: Used by the Spec Core Team to create a new release.
title: 'Matrix 1.X'
labels: 'release-blocker'
assignees: ''

---

<!-- ------------------------------------------------------------------------ -->
<!-- Please asssign the release coordinator (probably yourself) to this issue -->
<!-- ------------------------------------------------------------------------ -->

Date: **Thursday, May 25, 2023** <!-- CHANGE ME -->
Previous release: <!-- LINK TO LAST RELEASE'S CHECKLIST -->

Preflight checklist ([release steps](https://github.com/matrix-org/matrix-spec/blob/main/meta/releasing.md)):

* [ ] Blog post written
* [ ] Check for release blockers that may have been missed
* [ ] Review/fix the changelog

Release checklist ([release steps](https://github.com/matrix-org/matrix-spec/blob/main/meta/releasing.md)):
* [ ] Branch stuffs
* [ ] Github release artifact
* [ ] Published to spec.matrix.org
* [ ] All links work
* [ ] Publish blog post
* [ ] Announce in #matrix-spec, client developers, HS developers, SCT office, and other rooms as warranted
* [ ] Post to Twitter/Mastodon
* [ ] Close this issue

Known release blockers:
* [ ] <!-- Issue/PR link -->
1 change: 1 addition & 0 deletions changelogs/internal/newsfragments/1538.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document more of the spec release timeline/process.
45 changes: 45 additions & 0 deletions meta/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,51 @@ The whole specification is now released as a single unit/artifact. This document
the process for releasing the specification and a description of how the (public)
machinery works.

## Timeline

The spec is released each calendar quarter. The target release dates are within the
following ranges:

* Q1: January 20-27 (critically, before FOSDEM).
* Q2: May 20-27.
* Q3: August 20-27.
* Q4: November 1-15 (before recurring November conflicts, like IETF).

The SCT aims to have dates picked out by:

* Q1: January 10.
* Q2: May 1.
* Q3: August 1.
* Q4: October 15.

When a release date is picked, a [checklist](https://github.com/matrix-org/matrix-spec/issues/new?assignees=&labels=release-blocker&projects=&template=release.md&title=Matrix+1.X)
issue is created to track details of the release. Release blockers should continue to
be accepted up until 7 calendar days prior to the release date.

**Release dates are not promises.** The SCT reserves the ability to change, cancel,
postpone, etc a release for any reason. Do not rely on a release happening on a given
day until the release has actually happened & blog post published.

Once a release is scheduled, the SCT will begin planning what the next release is
expected to look like. The plan should be included in the spec release blog post,
and be ready for exeuction on spec release day. Plans are guides and not promises.

A blog post for the SCT members to review should be ready at minimum 1 week before
the target release date. 1-2 days before the release itself, the prerequisite steps
below are executed to ensure the spec release can go ahead.

## Release composition

*This section is a work in progress.*

Mentioned above, the SCT aims to have spec releases quarterly. Each quarter has a
slightly different theme to it:

* Q1: Massive feature release, if possible. This generally happens thanks to FOSDEM.
* Q2: Regular feature release, if possible.
* Q3: Momentum-continuing feature release, if possible.
* Q4: Preferably a maintenance release, but will accept features per normal.

## Prerequisites / preparation

First, can we even release the spec? This stage is mostly preparation work needed
Expand Down

0 comments on commit fbb8a78

Please sign in to comment.