Skip to content

Commit c7c6d12

Browse files
committed
cleanup
1 parent dfaeea8 commit c7c6d12

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

RELEASE.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ make docs
9595
2. Select the `Release` action.
9696
3. Run it on the main branch. Make sure `Release candidate` is checked and `Test PyPI` is not.
9797
4. Check on [PyPI][copulas-pypi] to assure the release candidate was successfully uploaded.
98+
- You should see X.Y.ZdevN PRE-RELEASE
9899

99100
[actions]: https://github.com/sdv-dev/Copulas/actions
100101
[copulas-pypi]: https://pypi.org/project/copulas/#history
@@ -180,19 +181,26 @@ make check-release
180181
## Bump Version
181182
The `stable` branch needs to updated with the changes from `main`. Run the following:
182183
```shell
184+
git checkout stable
185+
git pull origin stable
183186
git checkout main
184187
git pull origin main
185188
make git-merge-main-stable
186189
```
187190

188191
Depending on the type of release, you will need to one of these different commands to bump the version:
189192

190-
**Note**: Run `git pull origin main && git checkout main` first.
193+
**Note**: Run `git checkout main && git pull origin main` first. Then run one of the following:
191194

192195
* `bumpversion-patch`: 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.
193196
* `bumpversion-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.
194197
* `bumpversion-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.
195198

199+
Running one of these will **push commits directly** to `main`.
200+
At the end, you should see the 2 commits on `main` on (from oldest to newest):
201+
- `make release-tag: Merge branch 'main' into stable`
202+
- `Bump version: X.Y.Z.devN → X.Y.Z`
203+
196204
## Create the Release on GitHub
197205

198206
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).

0 commit comments

Comments
 (0)