Commit graph

39 commits

Author SHA1 Message Date
Michaël Zasso
3922d181b8
doc,tools: switch to @node-core/utils
Refs: https://github.com/nodejs/node-core-utils/releases/tag/v4.0.0
PR-URL: https://github.com/nodejs/node/pull/49851
Refs: https://github.com/nodejs/node-core-utils/pull/700
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
2023-09-25 11:48:03 +00:00
Claudio W
e79ef81289
doc: updated releasers instructions for node.js website
PR-URL: https://github.com/nodejs/node/pull/49427
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2023-09-05 18:29:01 +00:00
Rafael Gonzaga
478ca18fd7
doc: update to semver-minor releases by default
PR-URL: https://github.com/nodejs/node/pull/49175
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2023-08-17 19:23:25 +00:00
Rafael Gonzaga
de4553f3d1
doc: make the NODE_VERSION_IS_RELEASE revert clear
PR-URL: https://github.com/nodejs/node/pull/49114
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2023-08-13 22:48:34 +00:00
Rafael Gonzaga
bc8750ec19
doc: mention git node release prepare
Signed-off-by: RafaelGSS <rafael.nunu@hotmail.com>
PR-URL: https://github.com/nodejs/node/pull/48644
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
2023-07-06 12:54:51 +00:00
Antoine du Hamel
260092eca3
doc: harmonize fenced code snippet flags
We had a few code snippets that were using a non-descriptive tag (e.g.
`console` or `text`), whereas the actual language it's using describes
it better, and improves the syntax highlighting. This commit also
removes non-necessary leading chars (e.g. `$`, `>`, or `%`) to make it
easier for readers to copy and paste to try the command themselves.

PR-URL: https://github.com/nodejs/node/pull/48082
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2023-05-21 09:36:57 +02:00
Mohammed Keyvanzadeh
32e478d7c3
doc: fix typos
PR-URL: https://github.com/nodejs/node/pull/47685
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Debadree Chatterjee <debadree333@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
2023-04-23 13:34:08 +00:00
Rafael Gonzaga
17c9aa2f76
doc: fix release-post script location
Signed-off-by: RafaelGSS <rafael.nunu@hotmail.com>
PR-URL: https://github.com/nodejs/node/pull/47517
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com>
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2023-04-17 20:20:21 +00:00
Rafael Gonzaga
5e72051456
doc: drop one-week branch sync on major releases
PR-URL: https://github.com/nodejs/node/pull/47149
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
2023-03-24 15:11:18 +00:00
Bethany Nicolle Griggs
79a92cda14
doc: clarify semver-minor notable changes approach
Clarifies the current approach taken by releasers when crafting notable
changes for releases. This approach is also in line with the
implementation of the `git node release --prepare` tooling.

PR-URL: https://github.com/nodejs/node/pull/46592
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2023-02-21 20:15:37 +00:00
Rafael Gonzaga
60996372c4
doc: add note about major release rotation
Signed-off-by: RafaelGSS <rafael.nunu@hotmail.com>
PR-URL: https://github.com/nodejs/node/pull/46436
Fixes: https://github.com/nodejs/Release/issues/765
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
2023-02-02 12:39:18 +00:00
Juan José
d5b6a1814e
doc: correct the sed command for macOS in release process docs
PR-URL: https://github.com/nodejs/node/pull/46397
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
2023-01-31 18:58:12 +00:00
Rafael Gonzaga
e2fb7b813c
doc: mention how to run ncu-ci citgm
PR-URL: https://github.com/nodejs/node/pull/46090
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com>
2023-01-06 18:21:51 +00:00
Rafael Gonzaga
fd71d1a016
doc: include updating release optional step
PR-URL: https://github.com/nodejs/node/pull/46089
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com>
2023-01-06 18:21:40 +00:00
Ruy Adorno
361d34c514
tools: add release host var to promotion script
Adds a `NODEJS_RELEASE_HOST` environment variable that enable releasers
to provide a custom proxy host to connect to when performing the
promotion steps of a given release.

Signed-off-by: Ruy Adorno <ruyadorno@google.com>
PR-URL: https://github.com/nodejs/node/pull/45913
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2023-01-01 16:29:42 +00:00
Richard Lau
6fe6e762ab
doc: reduce likelihood of mismerges during release
Switch to the `patience` git diff algorithm to reduce the likelihood of
mismerges when the release commit is cherry-picked to the `main` branch.

Refs: https://github.com/nodejs/Release/issues/771#issuecomment-1352165054
PR-URL: https://github.com/nodejs/node/pull/45864
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
2022-12-16 21:07:33 +00:00
Michaël Zasso
a47939c75c
doc: remove release cleanup step
- The pull request is automatically closed.
- The branch is automatically deleted.

PR-URL: https://github.com/nodejs/node/pull/45858
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2022-12-16 14:14:49 +00:00
RafaelGSS
67edd725f2 doc: change make lint to make lint-md
This change might save some time during the release steps

PR-URL: https://github.com/nodejs/node/pull/45197
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
2022-10-27 20:52:51 -03:00
Ruy Adorno
e17e903188
doc: add more lts update steps to release guide
This changeset adds references to two steps required for promoting a
release line to LTS:

- Adding the new codename to nodejs-latest-linker repo
- Adding codename info to the Release repo

Signed-off-by: Ruy Adorno <ruyadorno@google.com>
PR-URL: https://github.com/nodejs/node/pull/45177
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
2022-10-27 20:33:30 +00:00
Ruy Adorno
1930fcd7ef
doc: update mark release line lts on release guide
Updates the Release Guide to point to using `node-core-utils` for
creating the commit that marks a release line as LTS.

Signed-off-by: Ruy Adorno <ruyadorno@google.com>
PR-URL: https://github.com/nodejs/node/pull/45101
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
2022-10-24 18:32:40 +00:00
Ruy Adorno
58cfb32962
doc: add major version note to release guide
Adding a note on how to properly edit the the `src/node_version.h` file
when working on the cherry-pick step of the Release Guide when working
on a new major version release.

Signed-off-by: Ruy Adorno <ruyadorno@google.com>
PR-URL: https://github.com/nodejs/node/pull/45054
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
2022-10-22 19:05:13 -04:00
Michaël Zasso
5815e3e232
doc: add note about latest GitHub release
Refs: https://github.blog/changelog/2022-10-21-explicitly-set-the-latest-release/
PR-URL: https://github.com/nodejs/node/pull/45111
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2022-10-22 07:27:00 +00:00
Rafael Gonzaga
7ceb624dce
doc: improve the workflow to test release binaries
PR-URL: https://github.com/nodejs/node/pull/45004
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2022-10-15 21:27:24 +00:00
RafaelGSS
e0c5b443af doc: mention git node backport
PR-URL: https://github.com/nodejs/node/pull/44764
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2022-09-26 11:50:22 -03:00
Rafael Gonzaga
247bb2f394 doc: ensure to revert node_version changes
PR-URL: https://github.com/nodejs/node/pull/44760
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>
2022-09-26 11:47:27 -03:00
RafaelGSS
68a3618bb4 doc: mention where to push security commits
PR-URL: https://github.com/nodejs/node/pull/44691
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2022-09-20 16:32:34 -03:00
Rafael Gonzaga
6f7118fa84
doc: mention how to get commit release
PR-URL: https://github.com/nodejs/node/pull/44572
Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2022-09-11 19:03:02 +00:00
RafaelGSS
db10f2c5a9 doc: mention cherry-pick edge-case on release
PR-URL: https://github.com/nodejs/node/pull/44408
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2022-08-29 10:06:43 -03:00
Ruy Adorno
808fe9828d
doc: note on release guide to update main branch
Added an extra command to make sure to remind me (and other releasers)
to update the `main` branch _before_ cherry-picking the release commit
to the branch.

Adding this command will often avoid unnecessary extra-work in case
there are mismatches between the local state of the main branch and
remote.

PR-URL: https://github.com/nodejs/node/pull/44384
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2022-08-28 01:05:31 +02:00
Ruy Adorno
5a40b074ab
doc: fix release guide example consistency
This changeset fixes two consistency issues in this single example that
guides releasers on how to push the tag to the remote repo.

The first issue is that the remote git reference is consistently
referred as `upstream` elsewhere in the guide.

The second issue being that the version example used in the rest of the
guide should be a fictional `v1.2.3` as stated in the "How to create a
release" guide notes:

>  * Examples will use the fictional release version `1.2.3`.

PR-URL: https://github.com/nodejs/node/pull/44385
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2022-08-27 09:54:40 +00:00
Beth Griggs
c7843659e2
doc: add security release specifics to releases.md
Co-authored-by: Rafael Gonzaga <rafael.nunu@hotmail.com>

PR-URL: https://github.com/nodejs/node/pull/43835
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2022-07-20 11:08:53 +01:00
Rafael Gonzaga
2f169ad58a
doc: clarify release process for new releasers
PR-URL: https://github.com/nodejs/node/pull/43739
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2022-07-13 18:30:19 +01:00
RafaelGSS
4176671a91 doc: update changelog-maker to the new flags
PR-URL: https://github.com/nodejs/node/pull/43696
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2022-07-07 14:08:36 -03:00
Richard Lau
5a8440bc51
doc: update main branch name in release guide
PR-URL: https://github.com/nodejs/node/pull/43437
Refs: https://github.com/nodejs/node/issues/33864
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2022-06-16 23:23:20 +01:00
Juan José
183447888b
doc: improve commit message example for releases
PR-URL: https://github.com/nodejs/node/pull/42954
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
2022-05-06 17:16:28 +01:00
Danielle Adams
32c86f513c
doc: update base branch name for nodejs/nodejs.org
PR-URL: https://github.com/nodejs/node/pull/42355
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
2022-03-16 14:20:10 +01:00
Danielle Adams
c51494e249
doc: add format-md step to release guide
PR-URL: https://github.com/nodejs/node/pull/41809
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2022-02-01 19:49:24 +00:00
Yoshiki Kurihara
5a61ca63b9
doc: fix typo in contributing guides
PR-URL: https://github.com/nodejs/node/pull/41723
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2022-01-28 11:07:55 +00:00
Michael Dawson
a199387f04 doc: make contributing info more discoverable
There are been several discussions in recent PRs about
the docs related to contributing not being very discoverable.
Move these docs from doc/guides/ to doc/contributing.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: https://github.com/nodejs/node/pull/41408
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
2022-01-18 14:24:30 -05:00
Renamed from doc/guides/releases.md (Browse further)