Skip to content

(chore): release notes cleanup #3074

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
May 20, 2025

Conversation

ilan-gold
Copy link
Contributor

@ilan-gold ilan-gold commented May 20, 2025

oops on us @dstansby!
TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.rst
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@dstansby
Copy link
Contributor

Huh, odd - I wonder why towncrier didn't pick these up when I ran it?

@ilan-gold
Copy link
Contributor Author

@dstansby towncrier matches exactly on the type of issue, I believe, if memory serves, probably. Mine was titled fix and the other was misspelled, I think, so it didn't recognize them as fragments.

@dstansby
Copy link
Contributor

Ah that would explain it. I wonder if there's a way we can catch these and error on CI before release... anyway, thanks for the fix here!

@dstansby dstansby enabled auto-merge (squash) May 20, 2025 12:31
@dstansby dstansby merged commit 80a09d7 into zarr-developers:main May 20, 2025
30 checks passed
@d-v-b
Copy link
Contributor

d-v-b commented May 20, 2025

Ah that would explain it. I wonder if there's a way we can catch these and error on CI before release... anyway, thanks for the fix here!

Could the "needs release notes" label check for valid (releasable) release notes?

@dstansby
Copy link
Contributor

Looks like twisted/towncrier#137 is a relevant issue

@ilan-gold
Copy link
Contributor Author

@dstansby We also use towncrier in anndata and I think we essentially have the same issue. The "best" we do is calling towncrier before actually building the docs so we can in theory (big emphasis there) check:

https://github.com/scverse/anndata/blob/bb2d44c0ad5757c5fc59844e2cf686009bb6073d/.readthedocs.yml#L10-L12

@ilan-gold ilan-gold deleted the ig/relnotes_cleanup branch May 20, 2025 15:31
@ilan-gold
Copy link
Contributor Author

You could actually probably edit that regex so it fails upon finding a non-supported md file (in our case).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants