Skip to content

Commit 89156b5

Browse files
authored
Update release documentation (#453)
1 parent d49d437 commit 89156b5

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

Makefile

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,4 +238,10 @@ release-test: check-release git-merge-main-stable bumpversion-release bumpversio
238238
release-candidate: check-main publish bumpversion-candidate git-push
239239

240240
.PHONY: release-candidate-test
241-
release-candidate-test: check-clean check-main publish-test
241+
release-candidate-test: check-clean check-main publish-test
242+
243+
.PHONY: release-minor
244+
release-minor: check-release bumpversion-minor release
245+
246+
.PHONY: release-major
247+
release-major: check-release bumpversion-major release

RELEASE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@ make check-release
149149
The `stable` branch needs to be updated with the changes from `main` and the version needs to be bumped.
150150
Depending on the type of release, run one of the following:
151151

152-
* `make release`: This will release a patch, which is the most common type of release. Use this when the changes are bugfixes or enhancements that do not modify the existing user API. Changes that modify the user API to add new features but that do not modify the usage of the previous features can also be released as a patch.
153-
* `make release-minor`: This will release the next minor version. Use this if the changes modify the existing user API in any way, even if it is backwards compatible. Minor backwards incompatible changes can also be released as minor versions while the library is still in beta state. After the major version 1 has been released, minor version can only be used to add backwards compatible API changes.
154-
* `make release-major`: This will release the next major version. Use this to if the changes modify the user API in a backwards incompatible way after the major version 1 has been released.
152+
* `make release`: This will release the version that has already been bumped (patch, minor, or major). By default, this is typically a patch release. Use this when the changes are bugfixes or enhancements that do not modify the existing user API. Changes that modify the user API to add new features but that do not modify the usage of the previous features can also be released as a patch.
153+
* `make release-minor`: This will bump and release the next minor version. Use this if the changes modify the existing user API in any way, even if it is backwards compatible. Minor backwards incompatible changes can also be released as minor versions while the library is still in beta state. After the major version v1.0.0 has been released, minor version can only be used to add backwards compatible API changes.
154+
* `make release-major`: This will bump and release the next major version. Use this if the changes modify the user API in a backwards incompatible way after the major version v1.0.0 has been released.
155155

156156
Running one of these will **push commits directly** to `main`.
157157
At the end, you should see the 3 commits on `main` (from oldest to newest):

0 commit comments

Comments
 (0)