File: release-procedure.md

package info (click to toggle)
python-semver 2.10.2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 296 kB
  • sloc: python: 1,589; makefile: 29
file content (52 lines) | stat: -rw-r--r-- 2,504 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Release Procedure

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

1. Verify that continuous integration for latest build was passing https://travis-ci.com/python-semver/python-semver

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/

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!

1. If one or several supported Python versions have been removed or added, verify that the 3 following files have been updated:
   * [setup.py](https://github.com/python-semver/python-semver/blob/master/setup.py)
   * [tox.ini](https://github.com/python-semver/python-semver/blob/master/tox.ini)
   * [.travis.yml](https://github.com/python-semver/python-semver/blob/master/.travis.yml)

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/

1. Add eventually new contributor(s) to [CONTRIBUTORS](https://github.com/python-semver/python-semver/blob/master/CONTRIBUTORS)

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`

1. Upload it to TestPyPI first:

    ```bash
    git clean -xfd
    python setup.py sdist bdist_wheel --universal
    twine upload --repository-url https://test.pypi.org/legacy/  dist/*
    ```

   If you have a `~/.pypirc` with a `testpyi` section, the upload can be
   simplified:

       twine upload --repository testpyi dist/*

1. Upload to PyPI

    ```bash
    git clean -xfd
    python setup.py register sdist bdist_wheel --universal
    twine upload dist/*
    ```

1. Go to https://pypi.org/project/semver/ to verify that new version is online and page is rendered correctly

1. Tag commit and push to github using command line interface

    ```bash
    git tag -a x.x.x -m 'Version x.x.x'
    git push python-semver master --tags
    ```

or using GitHub web interface available at https://github.com/python-semver/python-semver/releases