Skip to content

Commit 12c4f77

Browse files
authored
Update release documentation (#485)
1 parent d5b29b0 commit 12c4f77

File tree

2 files changed

+17
-14
lines changed

2 files changed

+17
-14
lines changed

Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,3 +262,9 @@ release-candidate: check-main publish bumpversion-candidate git-push
262262

263263
.PHONY: release-candidate-test
264264
release-candidate-test: check-clean check-main publish-test
265+
266+
.PHONY: release-minor
267+
release-minor: check-release bumpversion-minor release
268+
269+
.PHONY: release-major
270+
release-major: check-release bumpversion-major release

RELEASE.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The process of releasing a new version involves several steps:
1818

1919
8. [Check the release](#check-the-release)
2020

21-
8. [Update stable branch and bump version](#update-stable-branch-and-bump-version)
21+
9. [Update stable branch and bump version](#update-stable-branch-and-bump-version)
2222

2323
10. [Create the Release on GitHub](#create-the-release-on-github)
2424

@@ -82,7 +82,7 @@ make docs
8282
4. Check on [PyPI][copulas-pypi] to assure the release candidate was successfully uploaded.
8383
- You should see X.Y.ZdevN PRE-RELEASE
8484

85-
[actions]: https://github.com/sdv-dev/Copulas/actions
85+
[actions]: https://github.com/sdv-dev/copulas/actions
8686
[copulas-pypi]: https://pypi.org/project/copulas/#history
8787

8888
## Integration with SDV
@@ -115,7 +115,7 @@ git push --set-upstream origin test-copulas-X.Y.Z
115115

116116
## Milestone
117117

118-
It's important check that the GitHub and milestone issues are up to date with the release.
118+
It's important to check that the GitHub and milestone issues are up to date with the release.
119119

120120
You neet to check that:
121121

@@ -125,7 +125,7 @@ You neet to check that:
125125
be released anyway, move them to the next milestone.
126126
- All the issues in the milestone are assigned to at least one person.
127127
- All the pull requests closed since the latest release are associated to an issue. If necessary, create issues
128-
and assign them to the milestone. Also assigne the person who opened the issue to them.
128+
and assign them to the milestone. Also assign the person who opened the issue to them.
129129

130130
## Update HISTORY
131131
Run the [Release Prep](https://github.com/sdv-dev/Copulas/actions/workflows/prepare_release.yml) workflow. This workflow will create a pull request with updates to HISTORY.md
@@ -167,29 +167,26 @@ make check-release
167167
The `stable` branch needs to be updated with the changes from `main` and the version needs to be bumped.
168168
Depending on the type of release, run one of the following:
169169

170-
* `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.
171-
* `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.
172-
* `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.
170+
* `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.
171+
* `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.
172+
* `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.
173173

174174
Running one of these will **push commits directly** to `main`.
175-
At the end, you should see the 2 commits on `main` on (from oldest to newest):
175+
At the end, you should see the 3 commits on `main` (from oldest to newest):
176176
- `make release-tag: Merge branch 'main' into stable`
177177
- `Bump version: X.Y.Z.devN → X.Y.Z`
178+
- `Bump version: X.Y.Z -> X.Y.A.dev0`
178179

179180
## Create the Release on GitHub
180181

181182
After the update to HISTORY.md is merged into `main` and the version is bumped, it is time to [create the release GitHub](https://github.com/sdv-dev/Copulas/releases/new).
182183
- Create a new tag with the version number with a v prefix (e.g. v0.3.1)
183-
- The target should be the `main` branch
184+
- The target should be the `stable` branch
184185
- Release title is the same as the tag (e.g. v0.3.1)
185186
- This is not a pre-release (`Set as a pre-release` should be unchecked)
186187

187-
Click `Publish release`, which will kickoff the release workflow and automatically upload the package to public PyPI.
188-
189-
The release workflow will create a pull request and auto-merge it into `main` that bumps to the next development release. You should see 1 commit on main on:
190-
- `Bump version: X.Y.Z → X.Y.Z.dev0`
188+
Click `Publish release`, which will kickoff the release workflow and automatically upload the package to [public PyPI](https://pypi.org/project/copulas/).
191189

192190
## Close milestone and create new milestone
193191

194192
Finaly, **close the milestone** and, if it does not exist, **create the next milestone**.
195-

0 commit comments

Comments
 (0)