Skip to content

Commit

Permalink
docs: add release instructions to readme (#136)
Browse files Browse the repository at this point in the history
  • Loading branch information
ebk45 authored Jul 6, 2023
1 parent 4d3bce1 commit 4f3214d
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,15 @@ This project uses Maven. To run the tests locally, just run:
mvn clean verify
```

If you are a maintainer, you can release a new version by running this command locally: `mvn release:prepare`
If you are a maintainer, you can release a new version by doing the following:

- Merge the changes the need to be released into the `master` branch
- Checkout on to master locally and pull the latest changes
- Run `mvn release:prepare`, this will generate 2 commits that will bump the version of the github-java-client
- Push these changes to master
- Once the [release pipeline](https://github.com/spotify/github-java-client/actions/workflows/release.yml) has completed, the changes will have been tagged
- [Navigate to the tag](https://github.com/spotify/github-java-client/tags) associated with the changes and generate a manual release
- Once the release is generated, select the "Set as the latest release" checkbox and publish the release

## Notes about maturity

Expand Down

0 comments on commit 4f3214d

Please sign in to comment.