Tags

Debian release 3.0.2-1

Debian release 2.10.2-4

Version 3.0.2

Bug Fixes
* PR#418: Replace :class:`~collection.OrderedDict` with :class:`dict`.
  The dict datatype is ordered since Python 3.7. As we do not support
  Python 3.6 anymore, it can be considered safe to avoid
  :class:`~collection.OrderedDict`. Related to :gh:`419`.

* PR#426: Fix :meth:`~semver.version.Version.replace` method to use the
  derived class of an instance instead of :class:`~semver.version.Version`
  class.

Improved Documentation
* PR#431: Clarify version policy for the different semver versions
  (v2, v3, >v3) and the supported Python versions.
* #432: Improve external doc links to Python and Pydantic.

Features
* PR#417: Amend GitHub Actions to check against MacOS.

Trivial/Internal Changes
* PR#420: Introduce :py:class:`~typing.ClassVar` for some
  :class:`~semver.version.Version` class variables, mainly
  :data:`~semver.version.Version.NAMES` and some private.
* PR#421: Insert mypy configuration into :file:`pyproject.toml` and
  remove config options from :file:`tox.ini`.

Version 3.0.1

Bug fixes
* Issue #410: Export functions properly using ``__all__`` in ``__init__.py``.

Minor changes
* Ignore exit code from docformatter in checks tox.ini
* Correct typo in release-procedure.md
* Update CHANGELOG.rst

Version 3.0.0

* Fix #258: Keep semver._deprecated.compare
* Simplify max_ver and min_ver

Version: 3.0.0-rc.1

* Combine all dev releases together in one changelog
* Remove all changelog.d entries and integrate it into CHANGELOG
* Move dev releases to file changelog-semver3-devel.rst
* Split contributing into different sections
* Some doc polishing; use :meth: consistently for semver.Version methods
* Fix also some doc bugs

Version: 3.0.0-dev.4

Following issues/PRs were fixed for this release:

Bug Fixes
 * #374: Correct Towncrier’s config entries in the pyproject.toml file. The old entries [[tool.towncrier.type]] are deprecated and need to be replaced by [tool.towncrier.fragment.<TYPE>].

Deprecations
 * #372: Deprecate support for Python 3.6.

   Python 3.6 reached its end of life and isn’t supported anymore. At the time of writing (Dec 2022), the lowest version is 3.7.

   Although the poll didn’t cast many votes, the majority agree to remove support for Python 3.6.

Improved Documentation
 * #335: Add new section “Converting versions between PyPI and semver” the limitations and possible use cases to convert from one into the other versioning scheme.
 * #340: Describe how to get version from a file
 * #343: Describe combining Pydantic with semver in the “Advanced topic” section.
 * #350: Restructure usage section. Create subdirectory “usage/” and splitted all section into different files.
 * #351: Introduce new topics for:
   * “Migration to semver3”
   * “Advanced topics”

Features
 * PR #359: Add optional parameter optional_minor_and_patch in Version.parse() to allow optional minor and patch parts.
 * PR #362: Make Version.match() accept a bare version string as match expression, defaulting to equality testing.
 * #364: Enhance pyproject.toml to make it possible to use the pyproject-build command from the build module. For more information, see Building semver.
 * #365: Improve pyproject.toml.
   * Use setuptools, add metadata. Taken approach from A Practical Guide to Setuptools and Pyproject.toml.
   * Doc: Describe building of semver
   * Remove .travis.yml in MANIFEST.in (not needed anymore)
   * Distinguish between Python 3.6 and others in tox.ini
   * Add skip_missing_interpreters option for tox.ini
   * GH Action: Upgrade setuptools and setuptools-scm and test against 3.11.0-rc.2

Trivial/Internal Changes
 * #378: Fix some typos in Towncrier configuration

Version: 3.0.0-dev.3

Following issues/PRs were fixed for this release:

Bug Fixes

* #310: Rework API documentation. Follow a more “semi-manual” attempt
  and add auto directives into docs/api.rst.

Improved Documentation

* #312: Rework “Usage” section.
  * Mention the rename of VersionInfo to Version class
  * Remove `semver.` prefix in doctests to make examples shorter
  * Correct some references to dunder methods like `__getitem__()`,
    `__gt__()` etc.
  * Remove inconsistencies and mention module level function as
    deprecated and discouraged from using
  * Make empty `super()` call in `semverwithvprefix.py` example

* #315: Improve release procedure text

* #337: Improve documentation for semver max/min

Trivial/Internal Changes

* #309: Some (private) functions from the semver.version module has been changed.
  The following functions got renamed as it is only useful inside the
  Version class:

  * function `semver.version.comparator` got renamed to
    `semver.version._comparator()`
  * function `semver.version.cmp` got renamed to `semver.version._cmp()`

  The following functions got integrated into the Version class:

   * function `semver.version._nat_cmd` as a classmethod
   * function `semver.version.ensure_str`

* #313: Correct `tox.ini` for changelog entry to skip installation for
  semver. This should speed up the execution of towncrier.

* #316: Comparisons of Version class and other types return now a
  `NotImplemented` constant instead of a `TypeError` exception.

  The `NotImplemented` section of the Python documentation recommends
  returning this constant when comparing with `__gt__`, `__lt__`, and
  other comparison operators to “to indicate that the operation is not
  implemented with respect to the other type”.

* #319: Introduce stages in `.travis.yml`. The config file contains now
  two stages: check and test. If check fails, the test stage won’t be
  executed. This could speed up things when some checks fails.

* #322: Switch from Travis CI to GitHub Actions.

* #347: Support Python 3.10 in GitHub Action and other config files.

* Start supporting Python 3.10

Contributors

(in alphabetical order)

* @mzjp2
* @tlaferriere

Thanks to all! :heart:

Debian release 2.10.2-3

Debian release 2.10.2-2

Version: 3.0.0-dev.2

Following issues/PRs were fixed for this release:

 # Deprecations

-   #169: Deprecate CLI functions not
    imported from `semver.cli`.

 # Features

-   #169: Create semver package and split code among different modules in the packages:
    -   Remove `semver.py`
    -   Create `src/semver/__init__.py`
    -   Create `src/semver/cli.py` for all CLI methods
    -   Create `src/semver/_deprecated.py` for the `deprecated`
        decorator and other deprecated functions
    -   Create `src/semver/__main__.py` to allow calling the CLI using
        `python -m semver`
    -   Create `src/semver/_types.py` to hold type aliases
    -   Create `src/semver/version.py` to hold the `Version` class (old
        name `VersionInfo`) and its utility functions
    -   Create `src/semver/__about__.py` for all the metadata variables
-   #305: Rename `VersionInfo` to `Version` but keep an alias for compatibility

 # Improved Documentation

-   #304: Several improvements in documentation:
    -   Reorganize API documentation.
    -   Add migration chapter from semver2 to semver3.
    -   Distinguish between changlog for version 2 and 3
-   #305: Add note about `Version` rename.

 # Trivial/Internal Changes

-   #169: Adapted infrastructure code to the new project layout.

    -   Replace `setup.py` with `setup.cfg` because the
        `setup.cfg` is easier to use
    -   Adapt documentation code snippets where needed
    -   Adapt tests
    -   Changed the `deprecated` to hardcode the `semver` package name
        in the warning.

    Increase coverage to 100% for all non-deprecated APIs

-   #304: Support PEP-561 `py.typed`.

    According to the mentioned PEP:

    > \"Package maintainers who wish to support type checking of their
    > code MUST add a marker file named `py.typed` to their
    > package supporting typing.\"

    Add package\_data to `setup.cfg` to include this marker in dist and whl file.

 # Contributors

(in alphabetical order)

* @tlaferriere

Thanks to all! :heart:

Version: 3.0.0-dev.1

This is a major release. So many things were changed.
Following issues/PRs were fixed for this release:

* #290: Create semver 3.0.0-dev.1; mostly improving in
  * documentation: new layout to distinguish from the semver2 line.
    Also new logo, removed occurances of Python2, describe changelog
    process with Towncrier and update release process.
  * Introduce `changelog.d` directory for Towncrier. Used to
    improve process of our Changelog generation.
  * Remove old code in regards to Python2; also testing it against
    3.8, 3.9-dev, and 3.10-dev
* #234: Simplify `setup.py`
* #270: Configure Towncrier
* #276: Document how to create a subclass from `VersionInfo` class
* #291: Disallow negative numbers in `VersionInfo` arguments for
  `major`, `minor`, and `patch`.

Version 2.12.0

Following issues/PRs were fixed for this release:

* #287: Document how to create subclass from VersionInfo
* #283: Ensure equal versions have equal hashes

Version 2.12.0

Following issues/PRs were fixed for this release:

* Fix #291: Disallow negative numbers in VersionInfo (#292)

Version 2.11.0

* #274 / #275 String Types Py2 vs. Py3 compatibility
* #277 Turn VersionInfo.parse into classmethod to allow subclasses
* #286 Add author and update changelog for #276/#277

Debian release 2.10.2-1

Create semver version 2.10.2 (#271)

Following issues/PRs were fixed for this release:

* #160: Deprecated `semver.max_ver` and `semver.min_ver`
* #260: Fixed `__getitem__` returning None on wrong parts
* #263: Doc: Added missing "install" subcommand for openSUSE
* #268: Increased coverage

Create semver version 2.10.1 (#257)

Following issues/PRs were fixed for this release:

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

Create semver version 2.10.0 (#237)

Following issues/PRs were fixed for this release:

* #244: Allow list & str for comparison
* #236: Add missing deprecated functions
* #235: Shift focus on semver.VersionInfo.*
* #228: Add better doctest integration into pytest
* #225: Deprecate module level functions
* #224: Replace super() call (#226)
* #222: Implement of VersionInfo.next_version() function
* #138: Implement `__getitem__`

----

* README.rst: Remove :ref: role as it gives problems in twine
* setup.py: add project URLs
* Amend list of contributors
* Mention how to install semver from master
* tox.ini: added prepare-dist target to create distribution (whl
  and .tar.gz) and check with "twine check"

Co-authored-by: Sebastien Celles <scls19fr@users.noreply.github.com>