diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 0455560c..4e529404 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -16,6 +16,94 @@ in our repository. .. towncrier release notes start +Version 3.0.0-dev.1 +=================== + +:Released: 2020-10-26 +:Maintainer: Tom Schraitle + + +Deprecations +------------ + +* :pr:`290`: For semver 3.0.0-alpha0: + + * Remove anything related to Python2 + * In :file:`tox.ini` and :file:`.travis.yml` + Remove targets py27, py34, py35, and pypy. + Add py38, py39, and nightly (allow to fail) + * In :file:`setup.py` simplified file and remove + ``Tox`` and ``Clean`` classes + * Remove old Python versions (2.7, 3.4, 3.5, and pypy) + from Travis + +* :gh:`234`: In :file:`setup.py` simplified file and remove + ``Tox`` and ``Clean`` classes + + + +Features +-------- + +* :pr:`290`: Create semver 3.0.0-alpha0 + + * Update :file:`README.rst`, mention maintenance + branch ``maint/v2``. + * Remove old code mainly used for Python2 compatibility, + adjusted code to support Python3 features. + * Split test suite into separate files under :file:`tests/` + directory + * Adjust and update :file:`setup.py`. Requires Python >=3.6.* + Extract metadata directly from source (affects all the ``__version__``, + ``__author__`` etc. variables) + +* :gh:`270`: Configure Towncrier (:pr:`273`:) + + * Add :file:`changelog.d/.gitignore` to keep this directory + * Create :file:`changelog.d/README.rst` with some descriptions + * Add :file:`changelog.d/_template.rst` as Towncrier template + * Add ``[tool.towncrier]`` section in :file:`pyproject.toml` + * Add "changelog" target into :file:`tox.ini`. Use it like + :command:`tox -e changelog -- CMD` whereas ``CMD`` is a + Towncrier command. The default :command:`tox -e changelog` + calls Towncrier to create a draft of the changelog file + and output it to stdout. + * Update documentation and add include a new section + "Changelog" included from :file:`changelog.d/README.rst`. + +* :gh:`276`: Document how to create a sublass from :class:`VersionInfo` class + + + +Bug Fixes +--------- + +* :gh:`291`: Disallow negative numbers in VersionInfo arguments + for ``major``, ``minor``, and ``patch``. + + + +Improved Documentation +---------------------- + +* :pr:`290`: Several improvements in the documentation: + + * New layout to distinguish from the semver2 development line. + * Create new logo. + * Remove any occurances of Python2. + * Describe changelog process with Towncrier. + * Update the release process. + + + +Trivial/Internal Changes +------------------------ + +* :pr:`290`: Add supported Python versions to :command:`black`. + + + +---- Version 2.13.0 diff --git a/README.rst b/README.rst index fa001046..2baef45c 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,8 @@ +.. warning:: + + This is a development version. Do **NOT** use it + in production before the final 3.0.0 is released. + Quickstart ========== diff --git a/changelog.d/234.deprecation.rst b/changelog.d/234.deprecation.rst deleted file mode 100644 index bf0c0301..00000000 --- a/changelog.d/234.deprecation.rst +++ /dev/null @@ -1,2 +0,0 @@ -In :file:`setup.py` simplified file and remove -``Tox`` and ``Clean`` classes diff --git a/changelog.d/270.feature.rst b/changelog.d/270.feature.rst deleted file mode 100644 index 79a6ee4a..00000000 --- a/changelog.d/270.feature.rst +++ /dev/null @@ -1,13 +0,0 @@ -Configure Towncrier (:pr:`273`:) - -* Add :file:`changelog.d/.gitignore` to keep this directory -* Create :file:`changelog.d/README.rst` with some descriptions -* Add :file:`changelog.d/_template.rst` as Towncrier template -* Add ``[tool.towncrier]`` section in :file:`pyproject.toml` -* Add "changelog" target into :file:`tox.ini`. Use it like - :command:`tox -e changelog -- CMD` whereas ``CMD`` is a - Towncrier command. The default :command:`tox -e changelog` - calls Towncrier to create a draft of the changelog file - and output it to stdout. -* Update documentation and add include a new section - "Changelog" included from :file:`changelog.d/README.rst`. diff --git a/changelog.d/276.feature.rst b/changelog.d/276.feature.rst deleted file mode 100644 index 9fc4680b..00000000 --- a/changelog.d/276.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Document how to create a sublass from :class:`VersionInfo` class diff --git a/changelog.d/291.bugfix.rst b/changelog.d/291.bugfix.rst deleted file mode 100644 index 74ee4d87..00000000 --- a/changelog.d/291.bugfix.rst +++ /dev/null @@ -1,2 +0,0 @@ -Disallow negative numbers in VersionInfo arguments -for ``major``, ``minor``, and ``patch``. \ No newline at end of file diff --git a/changelog.d/pr290.deprecation.rst b/changelog.d/pr290.deprecation.rst deleted file mode 100644 index 1067d5f2..00000000 --- a/changelog.d/pr290.deprecation.rst +++ /dev/null @@ -1,10 +0,0 @@ -For semver 3.0.0-alpha0: - -* Remove anything related to Python2 -* In :file:`tox.ini` and :file:`.travis.yml` - Remove targets py27, py34, py35, and pypy. - Add py38, py39, and nightly (allow to fail) -* In :file:`setup.py` simplified file and remove - ``Tox`` and ``Clean`` classes -* Remove old Python versions (2.7, 3.4, 3.5, and pypy) - from Travis \ No newline at end of file diff --git a/changelog.d/pr290.doc.rst b/changelog.d/pr290.doc.rst deleted file mode 100644 index fa420ac9..00000000 --- a/changelog.d/pr290.doc.rst +++ /dev/null @@ -1,7 +0,0 @@ -Several improvements in the documentation: - -* New layout to distinguish from the semver2 development line. -* Create new logo. -* Remove any occurances of Python2. -* Describe changelog process with Towncrier. -* Update the release process. diff --git a/changelog.d/pr290.feature.rst b/changelog.d/pr290.feature.rst deleted file mode 100644 index f2a937a8..00000000 --- a/changelog.d/pr290.feature.rst +++ /dev/null @@ -1,11 +0,0 @@ -Create semver 3.0.0-alpha0 - -* Update :file:`README.rst`, mention maintenance - branch ``maint/v2``. -* Remove old code mainly used for Python2 compatibility, - adjusted code to support Python3 features. -* Split test suite into separate files under :file:`tests/` - directory -* Adjust and update :file:`setup.py`. Requires Python >=3.6.* - Extract metadata directly from source (affects all the ``__version__``, - ``__author__`` etc. variables) \ No newline at end of file diff --git a/changelog.d/pr290.trivial.rst b/changelog.d/pr290.trivial.rst deleted file mode 100644 index 9dc914f3..00000000 --- a/changelog.d/pr290.trivial.rst +++ /dev/null @@ -1 +0,0 @@ -Add supported Python versions to :command:`black`. diff --git a/docs/index.rst b/docs/index.rst index 0654dabd..aefdc843 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,12 +1,14 @@ Semver |version| -- Semantic Versioning ======================================= +.. include:: readme.rst + .. toctree:: :maxdepth: 2 :caption: Contents + :hidden: - readme install usage development @@ -15,12 +17,15 @@ Semver |version| -- Semantic Versioning .. toctree:: :maxdepth: 2 :caption: CLI + :hidden: pysemver .. toctree:: :maxdepth: 1 + :caption: Changelogs + :hidden: changelog changelog-2.7.9-and-before
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies: