-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Set lower bounds for supported dependency versions (#356)
Follow NEP29 and set lower bounds for the dependencies (all minor versions from the last 2 years). The only exception is xrft, which is new and likely requires v1.0 to work with Harmonica. Setup CI to run on lowest Python with lowest dependencies, highest Python with highest dependencies, and highest Python with optional dependencies. Use Dependente to extract the version information from setup.cfg instead of the custom export tool we had.
- Loading branch information
Showing
8 changed files
with
125 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
.. _compatibility: | ||
|
||
Version compatibility | ||
===================== | ||
|
||
Harmonica version compatibility | ||
------------------------------- | ||
|
||
Harmonica uses `semantic versioning <https://semver.org/>`__ (i.e., | ||
``MAJOR.MINOR.BUGFIX`` format). | ||
|
||
* Major releases mean that backwards incompatible changes were made. | ||
Upgrading will require users to change their code. | ||
* Minor releases add new features/data without changing existing functionality. | ||
Users can upgrade minor versions without changing their code. | ||
* Bug fix releases fix errors in a previous release without adding new | ||
functionality. Users can upgrade minor versions without changing their code. | ||
|
||
We will add ``FutureWarning`` messages about deprecations ahead of making any | ||
breaking changes to give users a chance to upgrade. | ||
|
||
.. warning:: | ||
|
||
The above does not apply to versions < ``1.0.0``. All ``0.*`` versions may | ||
deprecate, remove, or change functionality between releases. Proper | ||
warnings will be raised and any breaking changes will be marked as such in | ||
the :ref:`changes`. | ||
|
||
.. _dependency-versions: | ||
|
||
Supported dependency versions | ||
----------------------------- | ||
|
||
Harmonica follows the recommendations in | ||
`NEP29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`__ for setting | ||
the minimum required version of our dependencies. | ||
In short, we support **all minor releases of our dependencies from the previous | ||
24 months** before a Harmonica release with a minimum of 2 minor releases. | ||
|
||
We follow this guidance conservatively and won't require newer versions if the | ||
older ones are still working without causing problems. | ||
Whenever support for a version is dropped, we will include a note in the | ||
:ref:`changes`. | ||
|
||
.. note:: | ||
|
||
This was introduced in Harmonica v0.6.0. | ||
|
||
|
||
.. _python-versions: | ||
|
||
Supported Python versions | ||
------------------------- | ||
|
||
If you require support for older Python versions, please pin Harmonica to the | ||
following releases to ensure compatibility: | ||
|
||
.. list-table:: | ||
:widths: 40 60 | ||
|
||
* - **Python version** | ||
- **Last compatible release** | ||
* - 3.6 | ||
- 0.5.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.