Skip to content

Commit be73aac

Browse files
committed
update release.md
1 parent d5b29b0 commit be73aac

File tree

1 file changed

+14
-35
lines changed

1 file changed

+14
-35
lines changed

RELEASE.md

Lines changed: 14 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,21 @@ The process of releasing a new version involves several steps:
66

77
2. [Linting and tests](#linting-and-tests)
88

9-
3. [Documentation](#documentation)
9+
3. [Make a release candidate](#make-a-release-candidate)
1010

11-
4. [Make a release candidate](#make-a-release-candidate)
11+
4. [Integration with SDV](#integration-with-sdv)
1212

13-
5. [Integration with SDV](#integration-with-sdv)
13+
5. [Milestone](#milestone)
1414

15-
6. [Milestone](#milestone)
15+
6. [Update HISTORY](#update-history)
1616

17-
7. [Update HISTORY](#update-history)
18-
19-
8. [Check the release](#check-the-release)
17+
7. [Check the release](#check-the-release)
2018

2119
8. [Update stable branch and bump version](#update-stable-branch-and-bump-version)
2220

23-
10. [Create the Release on GitHub](#create-the-release-on-github)
21+
9. [Create the Release on GitHub](#create-the-release-on-github)
2422

25-
11. [Close milestone and create new milestone](#close-milestone-and-create-new-milestone)
23+
10. [Close milestone and create new milestone](#close-milestone-and-create-new-milestone)
2624

2725
## Install Copulas from source
2826

@@ -58,22 +56,6 @@ All checks passed!
5856

5957
The execution has finished with no errors, 0 test skipped and 7820 warnings.
6058

61-
## Documentation
62-
63-
The documentation must be up to date and generated with:
64-
65-
```bash
66-
make view-docs
67-
```
68-
69-
Read the documentation to ensure all the changes are reflected in the documentation.
70-
71-
Alternatively, you can simply generate the documentation using the command:
72-
73-
```bash
74-
make docs
75-
```
76-
7759
## Make a release candidate
7860

7961
1. On the Copulas GitHub page, navigate to the [Actions][actions] tab.
@@ -83,7 +65,7 @@ make docs
8365
- You should see X.Y.ZdevN PRE-RELEASE
8466

8567
[actions]: https://github.com/sdv-dev/Copulas/actions
86-
[copulas-pypi]: https://pypi.org/project/copulas/#history
68+
[copulas-pypi]: https://pypi.org/project/Copulas/#history
8769

8870
## Integration with SDV
8971

@@ -115,7 +97,7 @@ git push --set-upstream origin test-copulas-X.Y.Z
11597

11698
## Milestone
11799

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

120102
You neet to check that:
121103

@@ -125,7 +107,7 @@ You neet to check that:
125107
be released anyway, move them to the next milestone.
126108
- All the issues in the milestone are assigned to at least one person.
127109
- 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.
110+
and assign them to the milestone. Also assign the person who opened the issue to them.
129111

130112
## Update HISTORY
131113
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
@@ -172,24 +154,21 @@ Depending on the type of release, run one of the following:
172154
* `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.
173155

174156
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):
157+
At the end, you should see the 3 commits on `main` on (from oldest to newest):
176158
- `make release-tag: Merge branch 'main' into stable`
177159
- `Bump version: X.Y.Z.devN → X.Y.Z`
160+
- `Bump version: X.Y.Z -> X.Y.A.dev0`
178161

179162
## Create the Release on GitHub
180163

181164
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).
182165
- 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
166+
- The target should be the `stable` branch
184167
- Release title is the same as the tag (e.g. v0.3.1)
185168
- This is not a pre-release (`Set as a pre-release` should be unchecked)
186169

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`
170+
Click `Publish release`, which will kickoff the release workflow and automatically upload the package to [public PyPI](https://pypi.org/project/copulas/).
191171

192172
## Close milestone and create new milestone
193173

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

0 commit comments

Comments
 (0)