Skip to content

Clean up release notes in preparation for v3 #2634

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

Merged
merged 2 commits into from
Jan 8, 2025

Conversation

dstansby
Copy link
Contributor

@dstansby dstansby commented Jan 3, 2025

This cleans out the release notes page, in preparation for v3. I decided to:

  • Remove all the previous release notes for v1 and v2. These will get out of sync with new minor releases of v2, so I thought better to remove them and link out to the v2 branch for these.
  • Remove the existing v3 release notes. I think these dried up at some point, so instead of having an imcomplete set I thought better to remove them and link out to the v3 migration guide, and then start a normal release note service once v3 is released.

Thoughts?

@dstansby dstansby added the documentation Improvements to the documentation label Jan 3, 2025
@normanrz
Copy link
Member

normanrz commented Jan 4, 2025

Sounds like a good idea. I also stumbled across this issue because some old release notes link to sections in the docs that now describe very different behavior.

@dstansby dstansby added this to the 3.0.0 milestone Jan 5, 2025
@jhamman
Copy link
Member

jhamman commented Jan 8, 2025

+1 on doing this. Can we get this in tomorrow?

@dstansby dstansby force-pushed the 3.0-rel-notes branch 2 times, most recently from afc5086 to b381a3f Compare January 8, 2025 10:25
@dstansby dstansby marked this pull request as ready for review January 8, 2025 10:25
@dstansby dstansby force-pushed the 3.0-rel-notes branch 2 times, most recently from 1ea059a to 2557f1a Compare January 8, 2025 10:42
Copy link
Member

@jhamman jhamman left a comment

Choose a reason for hiding this comment

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

One small request but otherwise looks good.

@@ -0,0 +1,16 @@
Release notes
=============

Copy link
Member

Choose a reason for hiding this comment

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

Let's seed the release note section for 3.0.1

.. release_3.0.1:

3.0.1 (unreleased)
------------------

...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We shouldn't have the 3.0.1 title in the 3.0.0 release, so shouldn't we hold off here until after release?

Copy link
Member

Choose a reason for hiding this comment

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

We typically seed the release notes with the next release so contributors have a spot to start adding release notes. We can do this right after the 3.0.0 release I suppose.

Copy link
Member

Choose a reason for hiding this comment

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

In numcodecs, we also seed a section but without version number. https://github.com/zarr-developers/numcodecs/blob/main/docs/release.rst?plain=1#L16

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's after a release is made, the notes for the current release don't have an unreleased section: https://numcodecs.readthedocs.io/en/stable/release.html

@jhamman jhamman enabled auto-merge (squash) January 8, 2025 17:24
@jhamman jhamman merged commit 22ebded into zarr-developers:main Jan 8, 2025
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants