Skip to content

Commit

Permalink
Merge pull request #4992 from alphagov/release-docs-update-5.4.0
Browse files Browse the repository at this point in the history
Update release docs with learning from 5.4.0 release
  • Loading branch information
romaricpascal committed May 20, 2024
2 parents adfa0ab + a3a38ae commit ba4d142
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
8 changes: 7 additions & 1 deletion docs/releasing/publishing-a-pre-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,13 @@ Developers should pair on pre-releases. When working remotely, it can be useful
If the pre-release has been assigned the wrong tag (mistakes happen),
you can use [`npm dist-tag`](https://docs.npmjs.com/cli/v8/commands/npm-dist-tag) to quickly correct.

7. Run `npm logout` to log out from npm. If you've logged in through your browser, remember to log out from <https://npmjs.com> there as well.
7. Have a quick look at the diff of the new package with the previous one at:

```txt
https://diff.intrinsic.com/govuk-frontend/<PREVIOUS_VERSION_NUMBER>/<RELEASED_VERSION_NUMBER>
```

8. Run `npm logout` to log out from npm. If you've logged in through your browser, remember to log out from <https://npmjs.com> there as well.

## If publishing a beta pre-release, create a release on GitHub

Expand Down
22 changes: 21 additions & 1 deletion docs/releasing/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ See the [documentation on support branches](https://team-playbook.design-system.

Developers should pair on releases. When remote working, it can be useful to be on a call together.

> [!IMPORTANT]
> Before starting to publish, make sure the developer running the commands:
>
> - has [nvm](https://github.com/nvm-sh/nvm) or [`asdf`](https://asdf-vm.com/guide/getting-started.html)
> on their machine to install the correct version of NodeJS and npm
> - has access to Bitwarden to retreive the credentials for publishing on npm
1. Check out the **main** branch and pull the latest changes.

2. Ensure you're running the version of NodeJS matching [`.nvmrc`](/.nvmrc).
Expand Down Expand Up @@ -60,6 +67,13 @@ Developers should pair on releases. When remote working, it can be useful to be

1. Check out the **main** branch and pull the latest changes.

If there was an interruption between the raising of the PR and its merge,
or it's another developer running the publication to npm, rebuild the package with:

```shell
npm run build:package
```

2. Sign in to npm (`npm login`), using the credentials for the **govuk-patterns-and-tools** npm user from Bitwarden.

3. Run `npm run publish-release`, which will prompt you to check whether the npm tag looks as expected.
Expand All @@ -80,7 +94,13 @@ Developers should pair on releases. When remote working, it can be useful to be
If the release has been assigned the wrong tag (mistakes happen),
you can use [`npm dist-tag`](https://docs.npmjs.com/cli/v8/commands/npm-dist-tag) to quickly correct.

7. Run `npm logout` to log out from npm in the command line. If you've logged in through your browser, remember to log out from <https://npmjs.com> there as well.
7. Have a quick look at the diff of the new package with the previous one at:

```txt
https://diff.intrinsic.com/govuk-frontend/<PREVIOUS_VERSION_NUMBER>/<RELEASED_VERSION_NUMBER>
```

8. Run `npm logout` to log out from npm in the command line. If you've logged in through your browser, remember to log out from <https://npmjs.com> there as well.

## Create a release on Github

Expand Down

0 comments on commit ba4d142

Please sign in to comment.