Skip to content

Release 2.10.1 #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 13, 2020
Merged

Release 2.10.1 #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,22 @@ Change Log
All notable changes to this code base will be documented in this file,
in every released version.

Version 2.10.1 (WIP)
====================

:Released: 2020-0x-0y
:Maintainer:
Version 2.10.1
==============

:Released: 2020-05-13
:Maintainer: Tom Schraitle


Features
--------

* :pr:`249`: Added release policy and version restriction in documentation to
help our users which would like to stay on the major 2 release.
* :pr:`250`: Simplified installation semver on openSUSE with ``obs://``.
* :pr:`256`: Made docstrings consistent


Bug Fixes
---------
Expand Down
68 changes: 33 additions & 35 deletions release-procedure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,54 +1,52 @@
#################
Release procedure
#################
# Release Procedure

* 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 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

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

* 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 `__version__` in [semver.py](https://github.com/python-semver/python-semver/blob/master/semver.py) have been updated and follow https://semver.org/

* 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. 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!

* 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. 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)

* 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. 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/

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

* 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. 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`

* Upload it to TestPyPI first:
1. Upload it to TestPyPI first:

```bash
git clean -xfd
python setup.py register sdist bdist_wheel --universal
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
```
```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:
If you have a `~/.pypirc` with a `testpyi` section, the upload can be
simplified:

twine upload --repository testpyi dist/*
twine upload --repository testpyi dist/*

* Upload to PyPI
1. Upload to PyPI

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

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

* Tag commit and push to github using command line interface
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
```
```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