Skip to content

Commit 9d6483f

Browse files
Add release guide to CONTRIBUTING.md
1 parent 1cc22ee commit 9d6483f

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Thank you for your contribution to grpc-gateway.
44
Here's the recommended process of contribution.
55

66
1. `go get github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway`
7-
2. `cd $GOPATH/src/github.com/grpc-ecosystem/grpc-gateway`
8-
3. hack, hack, hack...
9-
4. Make sure that your change follows best practices in Go
7+
1. `cd $GOPATH/src/github.com/grpc-ecosystem/grpc-gateway`
8+
1. hack, hack, hack...
9+
1. Make sure that your change follows best practices in Go
1010
- [Effective Go](https://golang.org/doc/effective_go.html)
1111
- [Go Code Review Comments](https://golang.org/wiki/CodeReviewComments)
12-
5. Make sure that `go test ./...` passes.
13-
6. Sign [a Contributor License Agreement](https://cla.developers.google.com/clas)
14-
7. Open a pull request in Github
12+
1. Make sure that `go test ./...` passes.
13+
1. Sign [a Contributor License Agreement](https://cla.developers.google.com/clas)
14+
1. Open a pull request in Github
1515

1616
When you work on a larger contribution, it is also recommended that you get in touch
1717
with us through the issue tracker.
@@ -36,3 +36,22 @@ docker run -itv $(pwd):/grpc-gateway -w /grpc-gateway --entrypoint /bin/bash --r
3636
```
3737

3838
If this has resulted in some file changes in the repo, please ensure you check those in with your merge request.
39+
40+
### Making a release
41+
42+
To make a release, follow these steps:
43+
44+
1. Decide on a release version. The `gorelease` job can
45+
recommend whether the new release should be a patch or minor release.
46+
See [CircleCI](https://app.circleci.com/pipelines/github/grpc-ecosystem/grpc-gateway/126/workflows/255a8a04-de9c-46a9-a66b-f107d2b39439/jobs/6428)
47+
for an example.
48+
1. Generate a Github token with `repo` access.
49+
1. Create a new branch and edit the Makefile `changelog` job, settings
50+
the `future-release=` variable to the name of the version you plan to release
51+
1. Run `CHANGELOG_GITHUB_TOKEN=<yourtoken> make changelog`
52+
1. Commit the `Makefile` and `CHANGELOG.md` changes.
53+
1. Open a PR and check that everything looks right.
54+
1. Merge the PR.
55+
1. Tag the release on `master`, the tag should be made against the commit you just merged.
56+
1. (Optional) Delete your Github token again.
57+
1. (Required) Sit back and pat yourself on the back for a job well done :clap:.

0 commit comments

Comments
 (0)