Skip to content

Commit 8207374

Browse files
committed
Update release guide
1 parent 71ff747 commit 8207374

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

docs/MAINTAINING.md

+18-14
Original file line numberDiff line numberDiff line change
@@ -142,24 +142,28 @@ changelog](https://github.com/emacs-mirror/emacs/blob/master/etc/NEWS).
142142

143143
### Publishing a release
144144

145-
1. Go to GitHub Actions > Draft release > Run workflow off commit you want to
146-
release. CI will automatically upload the artifacts to the release. Make sure CI
147-
has finished on that commit.
148-
1. CI will automatically grab the
149-
artifacts, publish the NPM package from `npm-package`, and publish the Docker
150-
Hub image from `release-images`.
151-
1. Publish release.
152-
1. After, create a new branch called `release/v0.0.0` (replace 0s with actual version aka v4.5.0)
153-
1. Summarize the major changes in the `CHANGELOG.md`
154-
1. Bump chart version in `Chart.yaml`.
145+
1. Go to GitHub Actions > Draft release > Run workflow on the commit you want to
146+
release. Make sure CI has finished the build workflow on that commit or this
147+
will fail.
148+
2. CI will automatically grab the build artifact on that commit, inject the
149+
version into the `package.json`, put together platform-specific packages, and
150+
upload those packages to a draft release.
151+
3. Summarize the major changes in the `CHANGELOG.md`.
152+
4. Copy the relevant changelog section to the release then publish it.
153+
5. CI will automatically publish the NPM package, Docker image, and update
154+
Homebrew using the published release assets.
155+
6. Bump the chart version in `Chart.yaml` and merge in the changelog updates.
155156

156157
#### Release Candidates
157158

158-
We prefer to do release candidates so the community can test things before a full-blown release. To do this follow the same steps as above but:
159+
We prefer to do release candidates so the community can test things before a
160+
full-blown release. To do this follow the same steps as above but:
159161

160-
1. Only bump version in `package.json`
161-
1. use `0.0.0-rc.0`
162-
1. When you publish the release, select "pre-release"
162+
1. Add a `-rc.<number>` suffix to the version.
163+
2. When you publish the release select "pre-release". CI will not automatically
164+
publish pre-releases.
165+
3. Do not update the chart version or merge in the changelog until the final
166+
release.
163167

164168
#### AUR
165169

0 commit comments

Comments
 (0)