diff --git a/.github/workflows/build_workflow.yml b/.github/workflows/build_workflow.yml index 552ae1b6..108e40bd 100644 --- a/.github/workflows/build_workflow.yml +++ b/.github/workflows/build_workflow.yml @@ -11,7 +11,7 @@ on: env: CANCEL_OTHERS: true - PATHS_IGNORE: '["**/README.rst", "**/docs/**", "**/ISSUE_TEMPLATE/**", "**/pull_request_template.md", "**/.vscode/**"]' + PATHS_IGNORE: '["**/README.rst", "**/AUTHORS.rst", "**/CODE_OF_CONDUCT.rst", "**/HISTORY.rst", "**/CONTRIBUTING.rst", "**/docs/**", "**/ISSUE_TEMPLATE/**", "**/pull_request_template.md", "**/.vscode/**"]' jobs: skip-duplicate-actions: diff --git a/HISTORY.rst b/HISTORY.rst index 0f08e305..b03050a0 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -2,6 +2,40 @@ History ======= +v0.6.1 (29 November 2023) +------------------------- + +This patch version adds a default value to the ``axes`` argument in +``ds.bounds.add_missing_bounds()`` (``axes=["X", "Y", "T"]``). The ``axes`` +argument was added in v0.6.0 and did not have a default value, which +inadvertently introduced a breaking change to the API. + +``xesmf`` is now a required dependency because its core library, ESMF, +supports Windows as of Feb/2023. More information can be found +`here `_. + +Bug Fixes +~~~~~~~~~ + +- Add defaults to add_missing_bounds by `Ana Ordonez`_ in + https://github.com/xCDAT/xcdat/pull/569 + +DevOps +~~~~~~ + +- Make xESMF a required dependency by `Tom Vo`_ in + https://github.com/xCDAT/xcdat/pull/566 + +Documentation +~~~~~~~~~~~~~ + +- Update doc: Add link to the ESFG seminar xCDAT introduction video by `Jiwoo Lee`_ in + https://github.com/xCDAT/xcdat/pull/571 +- Fix v0.6.0 changelog headers for proper nesting by `Tom Vo`_ in + https://github.com/xCDAT/xcdat/pull/559 + +**Full Changelog**: https://github.com/xCDAT/xcdat/compare/v0.6.0...v0.6.1 + v0.6.0 (10 October 2023) ------------------------ @@ -92,7 +126,6 @@ DevOps **Full Changelog**: https://github.com/xCDAT/xcdat/compare/v0.5.0...v0.6.0 - v0.5.0 (27 March 2023) -------------------------- @@ -634,3 +667,4 @@ DevOps .. _Jiwoo Lee: https://github.com/lee1043 .. _Jill Chengzhu Zhang: https://github.com/chengzhuzhang .. _Paul Durack: https://github.com/durack1 +.. _Ana Ordonez: https://github.com/acordonez diff --git a/setup.py b/setup.py index 36b4ada0..71aff090 100755 --- a/setup.py +++ b/setup.py @@ -35,6 +35,6 @@ test_suite="tests", tests_require=test_requires, url="https://github.com/xCDAT/xcdat", - version="0.6.0", + version="0.6.1", zip_safe=False, ) diff --git a/tbump.toml b/tbump.toml index 995b3db3..10bd0f60 100644 --- a/tbump.toml +++ b/tbump.toml @@ -2,7 +2,7 @@ github_url = "https://github.com/xCDAT/xcdat" [version] -current = "0.6.0" +current = "0.6.1" # Example of a semver regexp. # Make sure this matches current_version before diff --git a/xcdat/__init__.py b/xcdat/__init__.py index d965cb46..899b55fc 100644 --- a/xcdat/__init__.py +++ b/xcdat/__init__.py @@ -20,4 +20,4 @@ from xcdat.temporal import TemporalAccessor # noqa: F401 from xcdat.utils import compare_datasets # noqa: F401 -__version__ = "0.6.0" +__version__ = "0.6.1" diff --git a/xcdat/bounds.py b/xcdat/bounds.py index ee59e61c..f59ea3ff 100644 --- a/xcdat/bounds.py +++ b/xcdat/bounds.py @@ -146,13 +146,13 @@ def add_missing_bounds( # noqa: C901 ``"time_bnds"`` and ``ds.time_bnds`` is present in the dataset. 5. For the "T" axis, its coordinates must be composed of datetime-like - objects (`np.datetime64` or `cftime`). + objects (``np.datetime64`` or ``cftime``). Parameters ---------- axes : List[str] - List of CF axes that function should operate on. Options include - "X", "Y", "T", or "Z". + List of CF axes that function should operate on, by default + ["X", "Y", "T"]. Options include "X", "Y", "T", or "Z". Returns -------