Skip to content

Commit

Permalink
doc: include updating release optional step
Browse files Browse the repository at this point in the history
  • Loading branch information
RafaelGSS committed Jan 4, 2023
1 parent a03529d commit eebd1b8
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions doc/contributing/releases.md
Expand Up @@ -20,6 +20,7 @@ official release builds for Node.js, hosted on <https://nodejs.org/>.
* [5. Create release commit](#5-create-release-commit)
* [6. Propose release on GitHub](#6-propose-release-on-github)
* [7. Ensure that the release branch is stable](#7-ensure-that-the-release-branch-is-stable)
* [7.1 Updating the release _(optional)_](#7-1-updating-the-release-optional)
* [8. Produce a nightly build _(optional)_](#8-produce-a-nightly-build-optional)
* [9. Produce release builds](#9-produce-release-builds)
* [10. Test the build](#10-test-the-build)
Expand Down Expand Up @@ -545,6 +546,44 @@ with the Build Working Group.

</details>

#### 7.1 Updating the release _(optional)_

Sometimes a release might be deferred to the subsequent day due to several
conditions:

* Unstable CI
* Late CI completion

And when it happens, the CHANGELOG\_Vx and the commit metadata needs to be
updated according to the new target date.

However, if it's just the changelog/commit message that has changed since the
last CI execution, there's no need to rerun CI, V8, or CITGM workflows.
The PR still needs a clean GitHub action run, and the original CI, V8, and
CITGM run should be in a visible comment.

There are some cases when a commit needs to be dropped or adjusted,
consider using the following approach:

1. Update staging

```console
$ git checkout v1.x-staging
$ git rebase -i $HASH_PREVIOUS_BAD_COMMIT
... drop or edit the bad commit(s)
$ git push -f upstream 1.x-staging
```

2. Rebase the proposal against the updated staging branch

```console
$ git checkout v1.2.3-proposal
$ git rebase upstream/staging
```

3. Re-run `changelog-maker` and update the CHANGELOG\_Vx to include the new
Git SHAs. Remember to update the commit message if applicable.

### 8. Produce a nightly build _(optional)_

If there is a reason to produce a test release for the purpose of having others
Expand Down

0 comments on commit eebd1b8

Please sign in to comment.