Skip to content

Commit 2b7820a

Browse files
committed
Prepare for version 0.4.0 release (part 10)
1 parent 6480c39 commit 2b7820a

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

release_procedure.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@ $./all.sh
2525

2626
For seeder: *to-be-completed*
2727

28-
## 4. Create a Source Distribution
28+
## 4. Tag the Release
29+
30+
Tag the state of the repo with the release version (e.g. `v0.4.0`) in GitHub.
31+
32+
## 5. Create a Source Distribution
2933

3034
```
3135
python3 setup.py sdist
@@ -50,7 +54,7 @@ are to be excluded from the distribution (e.g. via `MANIFEST.in` or the
5054
Note that to install the source distribution, the user will need to have `pip`
5155
installed a new-enough version of `setuptools` and also `wheel`.
5256

53-
## 5. Create a Universal Wheel
57+
## 6. Create a Universal Wheel
5458

5559
```
5660
python3 setup.py bdist_wheel
@@ -66,7 +70,7 @@ Note that `setup.cfg` specifies that wheels are universal by default.
6670
[Common Python Packaging Mistakes][2] is a particularly useful resource that I
6771
used in preparing the above two steps.
6872

69-
## 6. Upload to PyPI
73+
## 7. Upload to PyPI
7074

7175
Upload the source distribution and the universal wheel to the Python Package
7276
Index (PyPI).
@@ -88,7 +92,7 @@ repository: https://test.pypi.org/legacy/
8892
username: <username>
8993
```
9094

91-
### 6a. Test PyPI Server
95+
### 7a. Test PyPI Server
9296

9397

9498
```
@@ -108,7 +112,7 @@ venv/bin/pip install -i https://test.pypi.org/pypi/ framework-reproducibility
108112
rm -rf venv
109113
```
110114

111-
### 6b. Real PyPI Server
115+
### 7b. Real PyPI Server
112116

113117
```
114118
twine upload --repository pypi dist/framework-reproducibility-<version>.tar.gz
@@ -125,9 +129,9 @@ venv/bin/pip install framework-reproducibility
125129
rm -rf venv
126130
```
127131

128-
## 7. Create GitHub Release
132+
## 8. Create the GitHub Release
129133

130-
Finally, on GitHub, create a new release with an appropriate version tag
134+
Finally, on GitHub, create a new release using the version tag created earlier
131135
(e.g. `v0.4.0`).
132136

133137
[1]: https://packaging.python.org/guides/distributing-packages-using-setuptools/

0 commit comments

Comments
 (0)