Skip to content

Commit

Permalink
CONTRIBUTING.md: Suggest using github-changelog-generator. (#404)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewsomething authored Oct 27, 2020
1 parent ae45be7 commit 6929777
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ version number. Any code merged to main is subject to release.

## Releasing

Releasing a new version of godo is currently a manual process.
Releasing a new version of godo is currently a manual process.

Submit a separate pull request for the version change from the pull
request with your changes.
Expand All @@ -38,17 +38,32 @@ request with your changes.
for the next (unreleased) version does not exist, create one.
Include one bullet point for each piece of new functionality in the
release, including the pull request ID, description, and author(s).
For example:

```
## [v1.8.0] - 2019-03-13
- #210 Expose tags on storage volume create/list/get. - @jcodybaker
- #123 Update test dependencies - @digitalocean
- #210 - @jcodybaker - Expose tags on storage volume create/list/get.
- #123 - @digitalocean - Update test dependencies
```

To generate a list of changes since the previous release in the correct
format, you can use [github-changelog-generator](https://github.com/digitalocean/github-changelog-generator).
It can be installed from source by running:

```
go get -u github.com/digitalocean/github-changelog-generator
```

Next, list the changes by running:

```
github-changelog-generator -org digitalocean -repo godo
```

2. Update the `libraryVersion` number in `godo.go`.
3. Make a pull request with these changes. This PR should be separate from the PR containing the godo changes.
4. Once the pull request has been merged, [draft a new release](https://github.com/digitalocean/godo/releases/new).
5. Update the `Tag version` and `Release title` field with the new godo version. Be sure the version has a `v` prefixed in both places. Ex `v1.8.0`.
4. Once the pull request has been merged, [draft a new release](https://github.com/digitalocean/godo/releases/new).
5. Update the `Tag version` and `Release title` field with the new godo version. Be sure the version has a `v` prefixed in both places. Ex `v1.8.0`.
6. Copy the changelog bullet points to the description field.
7. Publish the release.

0 comments on commit 6929777

Please sign in to comment.