Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Final 4.0.0 updates #1868

Merged
merged 4 commits into from
Nov 19, 2024
Merged

Final 4.0.0 updates #1868

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
497c2ee
add convert_unknown_ndarray_subclasses default change to what's new
braingram Nov 8, 2024
2ce39ff
don't call towncrier for docs built from tags
braingram Nov 18, 2024
c5963f9
update changlelog for 4.0.0
braingram Nov 18, 2024
d081c54
update 4.0.0 release date
braingram Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ build:
pre_install:
- git update-index --assume-unchanged docs/rtd_environment.yaml docs/conf.py
post_install:
- towncrier build --keep
- git describe --exact-match || towncrier build --keep
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does this do?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! It's an attempt to fix #1844 where towncrier build --keep fails to build for a tagged commit.
For the 4.0.0 release the addition of the 4.0.0 tag will trigger readthedocs to build docs for that version (similar to https://asdf.readthedocs.io/en/3.5.0/). With the last release (the 3.5.0) that one failed because the 3.5.0 tag contained a changelog section for 3.5.0 already and towncrier saw the current commit was tagged so it failed when it tried to add a second 3.5.0 section.
With this command git describe --exact-match || towncrier build --keep the hope is that readthedocs when building the 4.0.0 docs will run the command and since git describe --exact-match will succeed (since the commit is an exact match for a tag) the second part of the command won't be run. This means towncrier build --keep won't run for a tagged commit but I think that's fine since tagged commits are either:

  • a commit for a release which will already have a changelog section for that version
  • a tag added to main to trigger scm_version to use a newer version where temporarily (for only that tagged commit) the 'latest' docs won't contain the development changelog (but the next commit added to main after the tag will trigger a 'latest' with the changelog)


conda:
environment: docs/rtd_environment.yaml
Expand Down
32 changes: 32 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
4.0.0 (2024-11-18)
==================

Feature
-------

- Switch default ASDF standard to 1.6.0. (`#1744
<https://github.com/asdf-format/asdf/pull/1744>`_)
- Raise RuntimeError if a Convert subclass supports multiple tags but doesn't
implement select_tag. (`#1853
<https://github.com/asdf-format/asdf/pull/1853>`_)


General
-------

- Set ``memmap=False`` to default for ``asdf.open`` and ``AsdfFile.__init__``.
(`#1801 <https://github.com/asdf-format/asdf/pull/1801>`_)


Removal
-------

- remove ``copy_arrays`` (replaced by ``memmap``) (`#1800
<https://github.com/asdf-format/asdf/pull/1800>`_)
- Remove deprecated API. See docs for full details. (`#1852
<https://github.com/asdf-format/asdf/pull/1852>`_)
- Switch default convert_unknown_ndarray_subclasses to False and issue
deprecation warning if it is enabled. (`#1858
<https://github.com/asdf-format/asdf/pull/1858>`_)


3.5.0 (2024-10-02)
==================

Expand Down
1 change: 0 additions & 1 deletion changes/1744.feature.rst
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion changes/1800.removal.rst
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion changes/1801.general.rst
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion changes/1852.removal.rst
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion changes/1853.feature.rst
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion changes/1858.removal.rst
View file
Open in desktop

This file was deleted.

16 changes: 16 additions & 0 deletions docs/asdf/whats_new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,22 @@ returned as lists. With asdf 4.0.0 this "implicit conversion" is
no longer performed which allows extensions to implement converters
for ``namedtuple`` instances.

.. _whats_new_4.0.0_unknown_ndarray_subclasses:

Unknown NDArray Subclasses
^^^^^^^^^^^^^^^^^^^^^^^^^^

In asdf 3.0.0 a config attribute was added
`asdf.config.AsdfConfig.convert_unknown_ndarray_subclasses` that
was enabled by default (to retain the behavior of the removed legacy
extension that handled ndarrays).

In asdf 4.0.0 this setting is disabled by default and issues a deprecation
warning when enabled. In an upcoming version of asdf this setting will
be removed.

See :ref:`convert_unknown_ndarray_subclasses` for more details.

3.0.0
=====

Expand Down
Loading