Skip to content

Commit 3b10440

Browse files
committed
doc: add table of contents to release guide
Also move Announce step to after technical stuff. PR-URL: #24042 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 99c2a10 commit 3b10440

File tree

1 file changed

+41
-13
lines changed

1 file changed

+41
-13
lines changed

doc/releases.md

+41-13
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,34 @@ The intended audience is those who have been authorized by the Node.js
55
Foundation Technical Steering Committee (TSC) to create, promote, and sign
66
official release builds for Node.js, hosted on <https://nodejs.org/>.
77

8+
## Table of Contents
9+
10+
* [Who can make a release?](#who-can-make-a-release)
11+
* [1. Jenkins Release Access](#1-jenkins-release-access)
12+
* [2. <nodejs.org> Access](#2-nodejsorg-access)
13+
* [3. A Publicly Listed GPG Key](#3-a-publicly-listed-gpg-key)
14+
* [How to create a release](#how-to-create-a-release)
15+
* [0. Pre-release steps](#0-pre-release-steps)
16+
* [1. Update the staging branch](#1-update-the-staging-branch)
17+
* [2. Create a new branch for the release](#2-create-a-new-branch-for-the-release)
18+
* [3. Update `src/node_version.h`](#3-update-srcnode_versionh)
19+
* [4. Update the Changelog](#4-update-the-changelog)
20+
* [5. Create Release Commit](#5-create-release-commit)
21+
* [6. Propose Release on GitHub](#6-propose-release-on-github)
22+
* [7. Ensure that the Release Branch is Stable](#7-ensure-that-the-release-branch-is-stable)
23+
* [8. Produce a Nightly Build _(optional)_](#8-produce-a-nightly-build-optional)
24+
* [9. Produce Release Builds](#9-produce-release-builds)
25+
* [10. Test the Build](#10-test-the-build)
26+
* [11. Tag and Sign the Release Commit](#11-tag-and-sign-the-release-commit)
27+
* [12. Set Up For the Next Release](#12-set-up-for-the-next-release)
28+
* [13. Promote and Sign the Release Builds](#13-promote-and-sign-the-release-builds)
29+
* [14. Check the Release](#14-check-the-release)
30+
* [15. Create a Blog Post](#15-create-a-blog-post)
31+
* [16. Create the release on GitHub](#16-create-the-release-on-github)
32+
* [17. Cleanup](#17-cleanup)
33+
* [18. Announce](#18-announce)
34+
* [19. Celebrate](#19-celebrate)
35+
836
## Who can make a release?
937

1038
Release authorization is given by the Node.js TSC. Once authorized, an
@@ -553,7 +581,19 @@ This script will use the promoted builds and changelog to generate the post. Run
553581
- Changes to `master` on the nodejs.org repo will trigger a new build of
554582
nodejs.org so your changes should appear in a few minutes after pushing.
555583

556-
### 16. Announce
584+
### 16. Create the release on GitHub
585+
586+
- Go to the [New release page](https://github.com/nodejs/node/releases/new).
587+
- Select the tag version you pushed earlier.
588+
- For release title, copy the title from the changelog.
589+
- For the description, copy the rest of the changelog entry.
590+
- Click on the "Publish release" button.
591+
592+
### 17. Cleanup
593+
594+
Close your release proposal PR and delete the proposal branch.
595+
596+
### 18. Announce
557597

558598
The nodejs.org website will automatically rebuild and include the new version.
559599
To announce the build on Twitter through the official @nodejs account, email
@@ -568,18 +608,6 @@ To ensure communication goes out with the timing of the blog post, please allow
568608
will be shared with the community in the email to coordinate these
569609
announcements.
570610

571-
### 17. Create the release on GitHub
572-
573-
- Got to the [New release page](https://github.com/nodejs/node/releases/new).
574-
- Select the tag version you pushed earlier.
575-
- For release title, copy the title from the changelog.
576-
- For the description, copy the rest of the changelog entry.
577-
- Click on the "Publish release" button.
578-
579-
### 18. Cleanup
580-
581-
Close your release proposal PR and delete the proposal branch.
582-
583611
### 19. Celebrate
584612

585613
_In whatever form you do this..._

0 commit comments

Comments
 (0)