Skip to content

Commit

Permalink
Merge pull request alphagov#538 from alphagov/update-release-docs
Browse files Browse the repository at this point in the history
Add npm login details to release docs
  • Loading branch information
Vanita Barrett-Smith authored Feb 8, 2022
2 parents f0e3e05 + 09febe3 commit aaf76ff
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,24 +144,25 @@ Then run:
git push --tags --set-upstream origin refs/heads/v1.2.3:refs/heads/v1.2.3
```

Create a pull request for the release.

To actually publish, you will need access to an `npm` account that owns `accessible-autocomplete`. Merge the version PR and then run:
Create a pull request for the release and merge once it has been approved, then run:

```bash
git checkout main
git pull --rebase
npm publish
```

[Create a new release](https://github.com/alphagov/accessible-autocomplete/releases/new) on GitHub.
1. Select the latest tag version.
2. Set "v[VERSION-NUMBER]" as the title.
3. Add the release notes from the changelog.
4. Add a summary of highlights.
5. Publish the release.
### Publish the release

1. Sign in to npm (`npm login`) using the [npm/govuk-patterns-and-tools team credentials](https://github.com/alphagov/design-system-team-credentials/tree/main/npm/govuk-patterns-and-tools).
2. Run `npm publish` to publish to npm.
3. Open the ['create a new release' dialog](https://github.com/alphagov/accessible-autocomplete/releases/new) on GitHub.
4. Select the latest tag version.
5. Set 'v[VERSION-NUMBER]' as the title.
6. Add the release notes from the changelog.
7. Add a summary of highlights.
8. Select **Publish release**.

You don't need to manually attach source code files to the release on GitHub.
You do not need to manually attach source code files to the release on GitHub.

Post a short summary of the release in the cross-government and GDS #govuk-design-system Slack channels. For example:

Expand Down

0 comments on commit aaf76ff

Please sign in to comment.