Skip to content

Commit

Permalink
chore(changelog): Add script to generate release notes (#285)
Browse files Browse the repository at this point in the history
* chore(changelog): Add script to generate release notes

Signed-off-by: Matt Roberts <code@rbrts.uk>

* docs(DEVELOPERS): Address PR feedback

Signed-off-by: Matt Roberts <code@rbrts.uk>
  • Loading branch information
mttrbrts authored Mar 15, 2021
1 parent 9678eda commit 57d3a82
Show file tree
Hide file tree
Showing 3 changed files with 8,503 additions and 45,293 deletions.
26 changes: 25 additions & 1 deletion DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,28 @@ npm run build

Storybook will reload with the applied changes.

[apdev]: https://github.com/accordproject/techdocs/blob/master/DEVELOPERS.md
[apdev]: https://github.com/accordproject/techdocs/blob/master/DEVELOPERS.md

## Releasing

Releases are made manually by maintainers through GitHub. Version tags follow semantic-versioning conventions with a `v` prefix, for example `v1.2.3`.

### Generating release notes from Pull Requests

A markdown changelog that includes the contributors and links to changes can be generated automatically through the `lerna-changelog` tool.

1. You will need a GitHub [Personal Access Token](https://github.com/settings/tokens) with `public_repo` permissions.
2. Review [all merged PRs since the last release](https://github.com/accordproject/web-components/pulls?q=is%3Apr+is%3Aclosed+is%3Amerged) to ensure that they are appropriately labelled with one of the following labels.
- `Type: Breaking Change 💥`
- `Type: Enhancement ✨`
- `Type: Bug 🐛`
- `Type: Chore 🧼`
- `Type: Documentation 📝`

> Note that `Type: Styling` and `Type: Feature Request` are not used, you should use `Type: Enhancement` instead.
3. Run the following command from the root folder of an up-to-date local clone of this repository to generate the markdown content.
```bash
GITHUB_AUTH=[YOUR_PERSONAL_ACCESS_TOKEN] npm run changelog:unreleased
```
4. Copy the markdown output from the terminal to the [GitHub release editor](https://github.com/accordproject/web-components/releases/new).
Loading

0 comments on commit 57d3a82

Please sign in to comment.