-
Notifications
You must be signed in to change notification settings - Fork 58
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
Final 4.0.0 updates #1868
Conversation
cf67d27
to
1e57172
Compare
1e57172
to
2ce39ff
Compare
The weldx downstream failure is expected. EDIT: weldx merged BAMWelDX/weldx#952 |
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what does this do?
There was a problem hiding this comment.
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)
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. |
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
pre-commit
on your machinepytest
on your machineno-changelog-entry-needed
)changes/
:echo "changed something" > changes/<PR#>.<changetype>.rst
(see below for change types)docs/
pagenews fragment change types...
changes/<PR#>.feature.rst
: new featurechanges/<PR#>.bugfix.rst
: bug fixchanges/<PR#>.doc.rst
: documentation changechanges/<PR#>.removal.rst
: deprecation or removal of public APIchanges/<PR#>.general.rst
: infrastructure or miscellaneous change