Workflow to label PRs with "needs release notes"

[Saransh-cpp]

See #1193 (comment)

This will -

• label a PR with "needs release notes" if docs/release.rst has not been edited
• remove the label as soon as docs/release.rst is edited

A working demo - Saransh-cpp#1

This will encourage (or maybe require, depending on the maintainers) developers to update release.rst with every PR!

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/tutorial.rst
• Changes documented in docs/release.rst
• GitHub Actions have all passed
• Test coverage is 100% (Codecov passes)

[jakirkham]

Interesting! This seems useful. Thanks Saransh 🙏

Wonder how this looks if we change the release note process to use release fragments ( #829 )?

[joshmoore]

My guess would be: - any: ['!.release-notes/*'] (or similar) would work, saying "you must have added a file under this directory.

[Saransh-cpp]

- any: ['!.release-notes/*']

Yes, this should work according to the examples listed in their README.

[joshmoore]

Nice!

[jakirkham]

Could you please send a PR to add this to Numcodecs too?

[jakirkham]

Thanks Saransh! 🙏 Merging when CI passes

[jakirkham]

(needed a release note 😉)

[Saransh-cpp]

Haha, missed that!

[joshmoore]

(needed a release note 😉)
Haha, missed that!

🤣