Skip to content
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

Jump to bottom

chore(changelog): Add script to generate release notes #285

Merged
merged 2 commits into from
Mar 15, 2021
Merged

chore(changelog): Add script to generate release notes #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6d0584
chore(changelog): Add script to generate release notes
mttrbrts Mar 10, 2021
2e590b1
docs(DEVELOPERS): Address PR feedback
mttrbrts Mar 10, 2021
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
26 changes: 25 additions & 1 deletion DEVELOPERS.md
View file
Open in desktop
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.
irmerk marked this conversation as resolved.
Show resolved Hide resolved

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