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.

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

merged 4 commits into from
Nov 19, 2024

Conversation

braingram
Copy link
Contributor

@braingram braingram commented Nov 8, 2024

Adds 'convert_unknown_ndarray_subclasses' change to what's new:
Closes #1865

Adds a check if the currently used git commit is tagged to the readthedocs configuration to close #1844
For an untagged commit towncrier build --keep will be called.
For a tagged commit towncrier build --keep will be skipped.

Updates changelog for 4.0.0.

Romancal regtests: https://github.com/spacetelescope/RegressionTests/actions/runs/11897984206
JWST regtests: https://github.com/spacetelescope/RegressionTests/actions/runs/11897987058
all pass with no AsdfWarning or AsdfDeprecationWarnings.

Tasks

  • run pre-commit on your machine
  • run pytest on your machine
  • Does this PR add new features and / or change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types)
    • update relevant docstrings and / or docs/ page
    • for any new features, add unit tests
news fragment change types...
  • changes/<PR#>.feature.rst: new feature
  • changes/<PR#>.bugfix.rst: bug fix
  • changes/<PR#>.doc.rst: documentation change
  • changes/<PR#>.removal.rst: deprecation or removal of public API
  • changes/<PR#>.general.rst: infrastructure or miscellaneous change

@braingram braingram force-pushed the update_whats_new branch 2 times, most recently from cf67d27 to 1e57172 Compare November 9, 2024 18:14
@braingram braingram changed the title add convert_unknown_ndarray_subclasses default change to what's new Final 4.0.0 updates Nov 18, 2024
@braingram braingram marked this pull request as ready for review November 18, 2024 19:08
@braingram braingram requested a review from a team as a code owner November 18, 2024 19:08
@braingram
Copy link
Contributor Author

braingram commented Nov 18, 2024

The weldx downstream failure is expected.
BAMWelDX/weldx#910 addresses the issues
alternatively BAMWelDX/weldx#952 pins "asdf < 4"

EDIT: weldx merged BAMWelDX/weldx#952

@braingram braingram requested review from perrygreenfield and zacharyburnett and removed request for a team November 18, 2024 19:10
@braingram braingram added this to the 4.0.0 milestone Nov 18, 2024
@@ -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)

@braingram
Copy link
Contributor Author

I pushed a small change to update the 4.0.0 changelog date to today: d081c54

I'm going to merge this then start the release. If all goes well it will go out today. If not I'll update the changelog on main.

@braingram braingram merged commit d676e11 into asdf-format:main Nov 19, 2024
48 of 49 checks passed
@braingram braingram deleted the update_whats_new branch November 19, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add convert_unknown_ndarray_subclasses default switch to "what's new" readthedocs failed on release
2 participants