bij1
/
gogreen
19
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

CONTRIBUTING.md: Suggest using github-changelog-generator. (#404)

This commit is contained in:
Andrew Starr-Bochicchio 2020-10-27 11:44:55 -04:00 committed by GitHub
parent ae45be7569
commit 6929777e5d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.md
View File

@ -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.
@ -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.