Skip to content

Navigation Menu

Sign in

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 8293ee0

Browse filesBrowse files
tomschrtomschr
authored
Merge pull request #348 from tomschr/release/3.0.0-dev.3
Release/3.0.0-dev.3
2 parents dd8f5f3 + 47f9f34 commit 8293ee0
Copy full SHA for 8293ee0

14 files changed

+137
-83
lines changed

‎CHANGELOG.rst

Copy file name to clipboardExpand all lines: CHANGELOG.rst
+85
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,91 @@ in our repository.
1717
.. towncrier release notes start
1818
1919
20+
Version 3.0.0-dev.3
21+
===================
22+
23+
:Released: 2022-01-19
24+
:Maintainer: Tom Schraitle
25+
26+
27+
Bug Fixes
28+
---------
29+
30+
* :gh:`310`: Rework API documentation.
31+
Follow a more "semi-manual" attempt and add auto directives
32+
into :file:`docs/api.rst`.
33+
34+
35+
36+
Improved Documentation
37+
----------------------
38+
39+
* :gh:`312`: Rework "Usage" section.
40+
41+
* Mention the rename of :class:`~semver.version.VersionInfo` to
42+
:class:`~semver.version.Version` class
43+
* Remove semver. prefix in doctests to make examples shorter
44+
* Correct some references to dunder methods like
45+
:func:`~.semver.version.Version.__getitem__`,
46+
:func:`~.semver.version.Version.__gt__` etc.
47+
* Remove inconsistencies and mention module level function as
48+
deprecated and discouraged from using
49+
* Make empty :py:func:`super` call in :file:`semverwithvprefix.py` example
50+
51+
* :gh:`315`: Improve release procedure text
52+
53+
54+
55+
Trivial/Internal Changes
56+
------------------------
57+
58+
* :gh:`309`: Some (private) functions from the :mod:`semver.version`
59+
module has been changed.
60+
61+
The following functions got renamed:
62+
63+
* function ``semver.version.comparator`` got renamed to
64+
:func:`semver.version._comparator` as it is only useful
65+
inside the :class:`~semver.version.Version` class.
66+
* function ``semver.version.cmp`` got renamed to
67+
:func:`semver.version._cmp` as it is only useful
68+
inside the :class:`~semver.version.Version` class.
69+
70+
The following functions got integrated into the
71+
:class:`~semver.version.Version` class:
72+
73+
* function ``semver.version._nat_cmd`` as a classmethod
74+
* function ``semver.version.ensure_str``
75+
76+
* :gh:`313`: Correct :file:`tox.ini` for ``changelog`` entry to skip
77+
installation for semver. This should speed up the execution
78+
of towncrier.
79+
80+
* :gh:`316`: Comparisons of :class:`~semver.version.Version` class and other
81+
types return now a :py:const:`NotImplemented` constant instead
82+
of a :py:exc:`TypeError` exception.
83+
84+
The `NotImplemented`_ section of the Python documentation recommends
85+
returning this constant when comparing with ``__gt__``, ``__lt__``,
86+
and other comparison operators to "to indicate that the operation is
87+
not implemented with respect to the other type".
88+
89+
.. _NotImplemented: https://docs.python.org/3/library/constants.html#NotImplemented
90+
91+
* :gh:`319`: Introduce stages in :file:`.travis.yml`
92+
The config file contains now two stages: check and test. If
93+
check fails, the test stage won't be executed. This could
94+
speed up things when some checks fails.
95+
96+
* :gh:`322`: Switch from Travis CI to GitHub Actions.
97+
98+
* :gh:`347`: Support Python 3.10 in GitHub Action and other config files.
99+
100+
101+
102+
----
103+
104+
20105
Version 3.0.0-dev.2
21106
===================
22107

‎changelog.d/309.trivial.rst

Copy file name to clipboardExpand all lines: changelog.d/309.trivial.rst
-17
This file was deleted.

‎changelog.d/310.bugfix.rst

Copy file name to clipboardExpand all lines: changelog.d/310.bugfix.rst
-3
This file was deleted.

‎changelog.d/312.doc.rst

Copy file name to clipboardExpand all lines: changelog.d/312.doc.rst
-11
This file was deleted.

‎changelog.d/313.trivial.rst

Copy file name to clipboardExpand all lines: changelog.d/313.trivial.rst
-3
This file was deleted.

‎changelog.d/316.trivial.rst

Copy file name to clipboardExpand all lines: changelog.d/316.trivial.rst
-10
This file was deleted.

‎changelog.d/319.trivial.rst

Copy file name to clipboardExpand all lines: changelog.d/319.trivial.rst
-4
This file was deleted.

‎changelog.d/322.trivial.rst

Copy file name to clipboardExpand all lines: changelog.d/322.trivial.rst
-1
This file was deleted.

‎changelog.d/347.trivial.rst

Copy file name to clipboardExpand all lines: changelog.d/347.trivial.rst
-1
This file was deleted.

‎docs/usage.rst

Copy file name to clipboardExpand all lines: docs/usage.rst
+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Getting the Version of semver
2626
To know the version of semver itself, use the following construct::
2727

2828
>>> semver.__version__
29-
'3.0.0-dev.2'
29+
'3.0.0-dev.3'
3030

3131

3232
Creating a Version

‎pyproject.toml

Copy file name to clipboardExpand all lines: pyproject.toml
+7-14
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,13 @@ build-backend = "setuptools.build_meta"
1111
line-length = 88
1212
target-version = ['py36', 'py37', 'py38', 'py39', 'py310']
1313
# diff = true
14-
exclude = '''
15-
(
16-
/(
17-
\.eggs # exclude a few common directories in the
18-
| \.git # root of the project
19-
| \.mypy_cache
20-
| \.tox
21-
| \.venv
22-
| \.env
23-
| _build
24-
| build
25-
| dist
26-
)/
27-
)
14+
extend-exclude = '''
15+
# A regex preceded with ^/ will apply only to files and directories
16+
# in the root of the project.
17+
^/*.py
18+
'''
19+
include = '''
20+
^/setup.py
2821
'''
2922

3023
[tool.towncrier]

‎release-procedure.md

Copy file name to clipboardExpand all lines: release-procedure.md
+42-16
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,31 @@ create a new release.
55

66
## Prepare the Release
77

8-
1. Verify that issues about new release are closed https://github.com/python-semver/python-semver/issues.
8+
1. Verify:
99

10-
1. 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.
10+
* all issues for a new release are closed: <https://github.com/python-semver/python-semver/issues>.
1111

12-
1. Verify that continuous integration for latest build was passing https://travis-ci.com/python-semver/python-semver.
12+
* that all pull requests that should be included in this release are merged: <https://github.com/python-semver/python-semver/pulls>.
1313

14-
1. Create a new branch `release/VERSION`.
14+
* that continuous integration for latest build was passing: <https://github.com/python-semver/python-semver/actions>.
15+
16+
1. Create a new branch `release/<VERSION>`.
1517

1618
1. If one or several supported Python versions have been removed or added, verify that the 3 following files have been updated:
17-
* [setup.py](https://github.com/python-semver/python-semver/blob/master/setup.py)
18-
* [tox.ini](https://github.com/python-semver/python-semver/blob/master/tox.ini)
19-
* [.travis.yml](https://github.com/python-semver/python-semver/blob/master/.travis.yml)
19+
* `setup.cfg`
20+
* `tox.ini`
21+
* `.git/workflows/pythonpackage.yml`
22+
23+
1. Verify that the version has been updated and follow
24+
<https://semver.org>:
25+
26+
* `src/semver/__about__.py`
27+
* `docs/usage.rst`
2028

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

23-
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.
31+
32+
1. Check if all changelog entries are created. If some are missing, [create them](https://python-semver.readthedocs.io/en/latest/development.html#adding-a-changelog-entry).
2433

2534
1. Show the new draft [CHANGELOG](https://github.com/python-semver/python-semver/blob/master/CHANGELOG.rst) entry for the latest release with:
2635

@@ -36,32 +45,47 @@ create a new release.
3645

3746
$ tox -e docs
3847

48+
1. Commit all changes, push, and create a pull request.
49+
3950

4051
## Create the New Release
4152

42-
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`
53+
1. Ensure that long description ([README.rst](https://github.com/python-semver/python-semver/blob/master/README.rst)) can be correctly rendered by Pypi using `restview --long-description`
54+
55+
1. Clean up your local Git repository. Be careful,
56+
as it **will remove all files** which are not
57+
versioned by Git:
58+
59+
$ git clean -xfd
60+
61+
Before you create your distribution files, clean
62+
the directory too:
63+
64+
$ rm dist/*
65+
66+
1. Create the distribution files (wheel and source):
67+
68+
$ tox -e prepare-dist
4369

4470
1. Upload the wheel and source to TestPyPI first:
4571

46-
```bash
47-
$ git clean -xfd
48-
$ rm dist/*
49-
$ python3 setup.py sdist bdist_wheel
72+
```bash
5073
$ twine upload --repository-url https://test.pypi.org/legacy/ dist/*
5174
```
5275

53-
If you have a `~/.pypirc` with a `testpyi` section, the upload can be
76+
If you have a `~/.pypirc` with a `testpypi` section, the upload can be
5477
simplified:
5578

56-
$ twine upload --repository testpyi dist/*
79+
$ twine upload --repository testpypi dist/*
5780

5881
1. Check if everything is okay with the wheel.
82+
Check also the web site `https://test.pypi.org/project/<VERSION>/`
5983

6084
1. Upload to PyPI:
6185

6286
```bash
6387
$ git clean -xfd
64-
$ python setup.py register sdist bdist_wheel
88+
$ tox -e prepare-dist
6589
$ twine upload dist/*
6690
```
6791

@@ -78,4 +102,6 @@ create a new release.
78102
document the new release.
79103
Usually it's enough to take it from a commit message or the tag description.
80104
105+
1. Announce it in <https://github.com/python-semver/python-semver/discussions/categories/announcements>.
106+
81107
You're done! Celebrate!

‎setup.cfg

Copy file name to clipboardExpand all lines: setup.cfg
+1-1
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ author_email = k-bx@k-bx.com
1414
maintainer = Sebastien Celles, Tom Schraitle
1515
maintainer_email = s.celles@gmail.com
1616
url = https://github.com/python-semver/python-semver
17-
download_url = https://github.com/python-semver/python-semver/downloads
1817
project_urls =
18+
Changelog = https://python-semver.readthedocs.io/en/latest/changelog.html
1919
Documentation = https://python-semver.rtfd.io
2020
Releases = https://github.com/python-semver/python-semver/releases
2121
Bug Tracker = https://github.com/python-semver/python-semver/issues

‎src/semver/__about__.py

Copy file name to clipboardExpand all lines: src/semver/__about__.py
+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"""
1717

1818
#: Semver version
19-
__version__ = "3.0.0-dev.2"
19+
__version__ = "3.0.0-dev.3"
2020

2121
#: Original semver author
2222
__author__ = "Kostiantyn Rybnikov"

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.