diff --git a/RELEASING.md b/RELEASING.md index 7daf66a..22ef7e9 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -7,19 +7,20 @@ bin/generate ``` After that, please review the changes to double check that the changes to the API spec were -generated correctly. Please open a Pull Request with the file changes and wait for the test pipeline -before merging it to main. +generated correctly. -## Step 2 - Update the version on `lib/tremendous/version.rb` +Please open a Pull Request with the file changes and wait for the test pipeline before merging it +to main. Make sure to use [Conventional Commit messages]([2]) to help automating the process - +specially `feat:` and `fix:`. -The Pull Request with the changes to the generated files should update the version on `lib/tremendous/version.rb` -following [Semantic Versioning][2] practices - most changes here should be backwards compatible and -deserve a MINOR version update +## Step 2 - Merge the Release Please Pull Request -## Step 3 - Publish a new release on GitHub +[Release Please](https://github.com/googleapis/release-please) will maintain a "Release PR" that +consolidates updates to `CHANGELOG.md` (based on the git history) and updating the `lib/tremendous/version.rb` +file. -The [publish.yml](.github/workflows/publish.yml) workflow is responsible for publishing the package to -Rubygems when a new release is published on GitHub. +When ready to publish a release, merge the Release PR and the [release.yml](.github/workflows/release.yml) +workflow will publish a new package to RubyGems and create a release on GitHub. [1]: https://openapi-generator.tech -[2]: https://semver.org +[2]: https://www.conventionalcommits.org/en/v1.0.0/