Skip to content

doc: update release steps when post-release fails #63131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RafaelGSS wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −10
Open

doc: update release steps when post-release fails #63131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 23 additions & 10 deletions doc/contributing/releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1090,15 +1090,27 @@ There is an automatic build that is kicked off when you promote new builds, so
within a few minutes nodejs.org will be listing your new version as the latest
release, and a blog post draft PR will be created.

In the event that a draft PR _is not created_, the [`scripts:release-post`][] script
can be used as an alternative:

```bash
# In the apps/site folder of nodejs/nodejs.org
node --run scripts:release-post x.y.z
```

This script will use the promoted builds and changelog to generate the post.
This is driven by the [`post-release.yml`][] workflow in the `nodejs/node`
repository, which triggers the [`create-release-post.yml`][] workflow on
`nodejs/nodejs.org`. The same workflow also triggers a redirect update in the
[`nodejs/release-cloudflare-worker`](https://github.com/nodejs/release-cloudflare-worker)
repository. Both steps must complete for the release to be fully available on
the website.

In the event that [`post-release.yml`][] fails, the **first step should be to
re-run the failed action** rather than manually triggering workflows in other
repositories. Skipping steps in the process can result in the blog post being
published without the release documents being available, or without the
Cloudflare redirects being updated.

If the failed action continues to fail after re-running, you can manually
trigger both of the following:

1. The [`create-release-post.yml`][] workflow on the `nodejs/nodejs.org`
repository.
2. The release worker update on the
[`nodejs/release-cloudflare-worker`](https://github.com/nodejs/release-cloudflare-worker)
repository.

* You can add a short blurb just under the main heading if you want to say
something important, otherwise the text should be publication ready.
Expand Down Expand Up @@ -1485,8 +1497,9 @@ Typical resolution: sign the release again.
[CI lockdown procedure]: https://github.com/nodejs/build/blob/HEAD/doc/jenkins-guide.md#restricting-access-for-security-releases
[Node.js Snap management repository]: https://github.com/nodejs/snap
[Snap]: https://snapcraft.io/node
[`create-release-post.yml`]: https://github.com/nodejs/nodejs.org/actions/workflows/create-release-post.yml
[`create-release-proposal`]: https://github.com/nodejs/node/actions/workflows/create-release-proposal.yml
[`scripts:release-post`]: https://github.com/nodejs/nodejs.org/blob/HEAD/apps/site/scripts/release-post/index.mjs
[`post-release.yml`]: https://github.com/nodejs/node/actions/workflows/post-release.yml
[build-infra team]: https://github.com/orgs/nodejs/teams/build-infra
[expected assets]: https://github.com/nodejs/build/tree/HEAD/ansible/www-standalone/tools/promote/expected_assets
[nodejs.org repository]: https://github.com/nodejs/nodejs.org
Loading