Skip to content

Commit 4f3214d

Browse files
authored
docs: add release instructions to readme (#136)
1 parent 4d3bce1 commit 4f3214d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,15 @@ This project uses Maven. To run the tests locally, just run:
8686
mvn clean verify
8787
```
8888

89-
If you are a maintainer, you can release a new version by running this command locally: `mvn release:prepare`
89+
If you are a maintainer, you can release a new version by doing the following:
90+
91+
- Merge the changes the need to be released into the `master` branch
92+
- Checkout on to master locally and pull the latest changes
93+
- Run `mvn release:prepare`, this will generate 2 commits that will bump the version of the github-java-client
94+
- Push these changes to master
95+
- Once the [release pipeline](https://github.com/spotify/github-java-client/actions/workflows/release.yml) has completed, the changes will have been tagged
96+
- [Navigate to the tag](https://github.com/spotify/github-java-client/tags) associated with the changes and generate a manual release
97+
- Once the release is generated, select the "Set as the latest release" checkbox and publish the release
9098

9199
## Notes about maturity
92100

0 commit comments

Comments
 (0)