Skip to content

Commit

Permalink
Merge pull request #452 from alphagov/improve-publishing-docs
Browse files Browse the repository at this point in the history
Improve docs for publishing a new version
  • Loading branch information
hannalaakso committed Jul 13, 2020
2 parents 672ef12 + 1efa78e commit 83cca31
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -138,13 +138,32 @@ npm version <major|minor|patch> -m "## 1.2.3 - 2017-01-13
- Change included in this release
- Another change included in this release"
```

Then run:
```bash
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:

```bash
git checkout master
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.

You don't 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:

🚀 We’ve just released Accessible Autocomplete v2.0.1. You can now use the acccessible autocomplete multiple times on one page. Thanks to @<SLACK-NAME> and @<SLACK-NAME> for helping with this release. [https://github.com/alphagov/accessible-autocomplete/releases/tag/v2.0.1](https://github.com/alphagov/accessible-autocomplete/releases/tag/v2.0.1)

0 comments on commit 83cca31

Please sign in to comment.