Fix #315: Create 3.0.0-dev.3

tomschr · tomschr · commit 221bfba902d1 · 2022-01-20T09:20:51.000+01:00
* Improve entries for PyPI in setup.cfg
  * Remove key "download_url" as it points to a broken URL
  * Add Changelog entry pointing to RTD
* Raise version to 3.0.0-dev.3
* Update release procedure
* Update Black formatter config
  * Replace "exclude" with "extend-exclude"
  * Ignore all *.py files in project's root directory
  * Include "setup.py" explicity
diff --git a/changelog.d/315.doc.rst b/changelog.d/315.doc.rst
@@ -0,0 +1 @@
+Improve release procedure text
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -26,7 +26,7 @@ Getting the Version of semver
 To know the version of semver itself, use the following construct::
 
    >>> semver.__version__
-   '3.0.0-dev.2'
+   '3.0.0-dev.3'
 
 
 Creating a Version
diff --git a/pyproject.toml b/pyproject.toml
@@ -11,20 +11,13 @@ build-backend = "setuptools.build_meta"
 line-length = 88
 target-version = ['py36', 'py37', 'py38', 'py39', 'py310']
 # diff = true
-exclude = '''
-(
-  /(
-    \.eggs         # exclude a few common directories in the
-    | \.git          # root of the project
-    | \.mypy_cache
-    | \.tox
-    | \.venv
-    | \.env
-    | _build
-    | build
-    | dist
-  )/
-)
+extend-exclude = '''
+# A regex preceded with ^/ will apply only to files and directories
+# in the root of the project.
+^/*.py
+'''
+include = '''
+^/setup.py
 '''
 
 [tool.towncrier]
diff --git a/release-procedure.md b/release-procedure.md
@@ -5,22 +5,31 @@ create a new release.
 
 ## Prepare the Release
 
-1. Verify that issues about new release are closed https://github.com/python-semver/python-semver/issues.
+1. Verify:
 
-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.
+   * all issues for a new release are closed: <https://github.com/python-semver/python-semver/issues>.
 
-1. Verify that continuous integration for latest build was passing https://travis-ci.com/python-semver/python-semver.
+   * that all pull requests that should be included in this release are merged: <https://github.com/python-semver/python-semver/pulls>.
 
-1. Create a new branch `release/VERSION`.
+   * that continuous integration for latest build was passing: <https://github.com/python-semver/python-semver/actions>.
+
+1. Create a new branch `release/<VERSION>`.
 
 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)
+   * `setup.cfg`
+   * `tox.ini`
+   * `.git/workflows/pythonpackage.yml`
+
+1. Verify that the version has been updated and follow
+   <https://semver.org>:
+
+   * `src/semver/__about__.py`
+   * `docs/usage.rst`
 
 1. Add eventually new contributor(s) to [CONTRIBUTORS](https://github.com/python-semver/python-semver/blob/master/CONTRIBUTORS).
 
-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. 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).
 
 1. Show the new draft [CHANGELOG](https://github.com/python-semver/python-semver/blob/master/CHANGELOG.rst) entry for the latest release with:
 
@@ -36,32 +45,47 @@ create a new release.
 
        $ tox -e docs
 
+1. Commit all changes, push, and create a pull request.
+
 
 ## Create the New Release
 
-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. 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`
+
+1. Clean up your local Git repository. Be careful,
+   as it **will remove all files** which are not
+   versioned by Git:
+
+       $ git clean -xfd
+
+   Before you create your distribution files, clean
+   the directory too:
+
+       $ rm dist/*
+
+1. Create the distribution files (wheel and source):
+
+       $ tox -e prepare-dist
 
 1. Upload the wheel and source to TestPyPI first:
 
-    ```bash
-    $ git clean -xfd
-    $ rm dist/*
-    $ python3 setup.py sdist bdist_wheel
+    ```bash    
     $ twine upload --repository-url https://test.pypi.org/legacy/  dist/*
     ```
 
-   If you have a `~/.pypirc` with a `testpyi` section, the upload can be
+   If you have a `~/.pypirc` with a `testpypi` section, the upload can be
    simplified:
 
-       $ twine upload --repository testpyi dist/*
+       $ twine upload --repository testpypi dist/*
 
 1. Check if everything is okay with the wheel.
+   Check also the web site `https://test.pypi.org/project/<VERSION>/`
 
 1. Upload to PyPI:
 
     ```bash
     $ git clean -xfd
-    $ python setup.py register sdist bdist_wheel
+    $ tox -e prepare-dist
     $ twine upload dist/*
     ```
 
@@ -78,4 +102,6 @@ create a new release.
    document the new release.
    Usually it's enough to take it from a commit message or the tag description.
 
+1. Announce it in <https://github.com/python-semver/python-semver/discussions/categories/announcements>.
+
 You're done! Celebrate!
diff --git a/setup.cfg b/setup.cfg
@@ -14,8 +14,8 @@ author_email = k-bx@k-bx.com
 maintainer = Sebastien Celles, Tom Schraitle
 maintainer_email = s.celles@gmail.com
 url = https://github.com/python-semver/python-semver
-download_url = https://github.com/python-semver/python-semver/downloads
 project_urls =
+    Changelog = https://python-semver.readthedocs.io/en/latest/changelog.html
     Documentation = https://python-semver.rtfd.io
     Releases = https://github.com/python-semver/python-semver/releases
     Bug Tracker = https://github.com/python-semver/python-semver/issues
diff --git a/src/semver/__about__.py b/src/semver/__about__.py
@@ -16,7 +16,7 @@
 """
 
 #: Semver version
-__version__ = "3.0.0-dev.2"
+__version__ = "3.0.0-dev.3"
 
 #: Original semver author
 __author__ = "Kostiantyn Rybnikov"
