|
1 | | -################# |
2 | | -Release procedure |
3 | | -################# |
| 1 | +# Release Procedure |
4 | 2 |
|
5 | | -* Verify that issues about new release are closed https://github.com/python-semver/python-semver/issues and verify that no pull requests that should be included in this release haven't been left out https://github.com/python-semver/python-semver/pulls |
| 3 | +1. Verify that issues about new release are closed https://github.com/python-semver/python-semver/issues and verify that no pull requests that should be included in this release haven't been left out https://github.com/python-semver/python-semver/pulls |
6 | 4 |
|
7 | | -* Verify that continuous integration for latest build was passing https://travis-ci.com/python-semver/python-semver |
| 5 | +1. Verify that continuous integration for latest build was passing https://travis-ci.com/python-semver/python-semver |
8 | 6 |
|
9 | | -* Verify that `__version__` in [semver.py](https://github.com/python-semver/python-semver/blob/master/semver.py) have been updated and follow https://semver.org/ |
| 7 | +1. Verify that `__version__` in [semver.py](https://github.com/python-semver/python-semver/blob/master/semver.py) have been updated and follow https://semver.org/ |
10 | 8 |
|
11 | | -* Verify that [CHANGELOG](https://github.com/python-semver/python-semver/blob/master/CHANGELOG.rst) have been updated. No WIP should be present in CHANGELOG during release! |
| 9 | +1. Verify that [CHANGELOG](https://github.com/python-semver/python-semver/blob/master/CHANGELOG.rst) have been updated. No WIP should be present in CHANGELOG during release! |
12 | 10 |
|
13 | | -* If one or several supported Python versions have been removed or added, verify that the 3 following files have been updated: |
14 | | - * [setup.py](https://github.com/python-semver/python-semver/blob/master/setup.py) |
15 | | - * [tox.ini](https://github.com/python-semver/python-semver/blob/master/tox.ini) |
16 | | - * [.travis.yml](https://github.com/python-semver/python-semver/blob/master/.travis.yml) |
| 11 | +1. If one or several supported Python versions have been removed or added, verify that the 3 following files have been updated: |
| 12 | + * [setup.py](https://github.com/python-semver/python-semver/blob/master/setup.py) |
| 13 | + * [tox.ini](https://github.com/python-semver/python-semver/blob/master/tox.ini) |
| 14 | + * [.travis.yml](https://github.com/python-semver/python-semver/blob/master/.travis.yml) |
17 | 15 |
|
18 | | -* Verify that doc reflecting new changes have been updated and are available at https://python-semver.readthedocs.io/en/latest/ If necessary, trigger doc build at https://readthedocs.org/projects/python-semver/ |
| 16 | +1. Verify that doc reflecting new changes have been updated and are available at https://python-semver.readthedocs.io/en/latest/ If necessary, trigger doc build at https://readthedocs.org/projects/python-semver/ |
19 | 17 |
|
20 | | -* Add eventually new contributor(s) to [CONTRIBUTORS](https://github.com/python-semver/python-semver/blob/master/CONTRIBUTORS) |
| 18 | +1. Add eventually new contributor(s) to [CONTRIBUTORS](https://github.com/python-semver/python-semver/blob/master/CONTRIBUTORS) |
21 | 19 |
|
22 | | -* Ensure that long description (ie [README.rst](https://github.com/python-semver/python-semver/blob/master/README.rst)) can be correctly rendered by Pypi using `restview --long-description` |
| 20 | +1. Ensure that long description (ie [README.rst](https://github.com/python-semver/python-semver/blob/master/README.rst)) can be correctly rendered by Pypi using `restview --long-description` |
23 | 21 |
|
24 | | -* Upload it to TestPyPI first: |
| 22 | +1. Upload it to TestPyPI first: |
25 | 23 |
|
26 | | -```bash |
27 | | -git clean -xfd |
28 | | -python setup.py register sdist bdist_wheel --universal |
29 | | -twine upload --repository-url https://test.pypi.org/legacy/ dist/* |
30 | | -``` |
| 24 | + ```bash |
| 25 | + git clean -xfd |
| 26 | + python setup.py sdist bdist_wheel --universal |
| 27 | + twine upload --repository-url https://test.pypi.org/legacy/ dist/* |
| 28 | + ``` |
31 | 29 |
|
32 | | - If you have a `~/.pypirc` with a `testpyi` section, the upload can be |
33 | | - simplified: |
| 30 | + If you have a `~/.pypirc` with a `testpyi` section, the upload can be |
| 31 | + simplified: |
34 | 32 |
|
35 | | - twine upload --repository testpyi dist/* |
| 33 | + twine upload --repository testpyi dist/* |
36 | 34 |
|
37 | | -* Upload to PyPI |
| 35 | +1. Upload to PyPI |
38 | 36 |
|
39 | | -```bash |
40 | | -git clean -xfd |
41 | | -python setup.py register sdist bdist_wheel --universal |
42 | | -twine upload dist/* |
43 | | -``` |
| 37 | + ```bash |
| 38 | + git clean -xfd |
| 39 | + python setup.py register sdist bdist_wheel --universal |
| 40 | + twine upload dist/* |
| 41 | + ``` |
44 | 42 |
|
45 | | -* Go to https://pypi.org/project/semver/ to verify that new version is online and page is rendered correctly |
| 43 | +1. Go to https://pypi.org/project/semver/ to verify that new version is online and page is rendered correctly |
46 | 44 |
|
47 | | -* Tag commit and push to github using command line interface |
| 45 | +1. Tag commit and push to github using command line interface |
48 | 46 |
|
49 | | -```bash |
50 | | -git tag -a x.x.x -m 'Version x.x.x' |
51 | | -git push python-semver master --tags |
52 | | -``` |
| 47 | + ```bash |
| 48 | + git tag -a x.x.x -m 'Version x.x.x' |
| 49 | + git push python-semver master --tags |
| 50 | + ``` |
53 | 51 |
|
54 | 52 | or using GitHub web interface available at https://github.com/python-semver/python-semver/releases |
0 commit comments