You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
119
119
120
120
You neet to check that:
121
121
@@ -125,7 +125,7 @@ You neet to check that:
125
125
be released anyway, move them to the next milestone.
126
126
- All the issues in the milestone are assigned to at least one person.
127
127
- 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.
129
129
130
130
## Update HISTORY
131
131
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
167
167
The `stable` branch needs to be updated with the changes from `main` and the version needs to be bumped.
168
168
Depending on the type of release, run one of the following:
169
169
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.
173
173
174
174
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):
176
176
-`make release-tag: Merge branch 'main' into stable`
177
177
-`Bump version: X.Y.Z.devN → X.Y.Z`
178
+
-`Bump version: X.Y.Z -> X.Y.A.dev0`
178
179
179
180
## Create the Release on GitHub
180
181
181
182
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).
182
183
- 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
184
185
- Release title is the same as the tag (e.g. v0.3.1)
185
186
- This is not a pre-release (`Set as a pre-release` should be unchecked)
186
187
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/).
191
189
192
190
## Close milestone and create new milestone
193
191
194
192
Finaly, **close the milestone** and, if it does not exist, **create the next milestone**.
0 commit comments