-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Added towncrier as a github workflow #8792
Conversation
|
||
* ``removal``: Signifying a deprecation or removal of public API. | ||
|
||
* ``misc``: A ticket has been closed, but it is not of interest to users. |
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.
These are the default categories of changes provided by towncrier
.
(https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments)
cc @numba/fpoc; We should be putting together a custom category list of changes that are to be reflected in the auto-generated release notes.
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.
Made the following list of categories adapted from NumPy:
* ``highlight``: Adds a highlight bullet point to use as a possibly highlight
of the release.
* ``np_support``: Addition of new NumPy functionality.
* ``deprecation``: Changes existing code to emit a DeprecationWarning.
* ``expired``: Removal of a deprecated part of the API.
* ``compatibility``: A change which requires users to change code and is not
backwards compatible. (Not to be used for removal of deprecated features.)
* ``cuda``: Changes in the CUDA API.
* ``new_feature``: New user facing features like ``kwargs``.
* ``improvement``: General improvements and edge-case changes which are
not new features or compatibility related.
* ``performance``: Performance changes that should not affect other behaviour.
* ``change``: Other changes
* ``doc``: Documentation Changes
* ``infrastructure``: Infrastructure related changes.
* ``bug_fix``: Any kind of bug fixes.
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.
@kc611 Suggest raising this at the next maintainer/triage meeting to make sure that this list acceptable to all maintainers, also think that the general form of the release notes needs a general discussion/acceptance from the same group.
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.
Looking most at GitHub Actions
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 for working on this @kc611, this should help with automating the release process. I've not looked at the GHA workflows as @apmasell has done so (thanks @apmasell!). I've also not tested this manually. I have however reviewed the remaining content, most of the suggestions are minor things, but as noted in another comment, I suggest raising this PR for discussion at development meetings next week so as to ensure other interested parties are aware and have the opportunity to comment. Thanks again!
docs/upcoming_changes/README.rst
Outdated
.. note:: | ||
This README was adapted from the NumPy changelog readme under the terms of | ||
the MIT licence. |
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.
I think that this should be a comment in a style compliant with
Lines 454 to 461 in e7a1e83
NumPy (https://github.com/numpy/numpy) | |
-------------------------------------- | |
Numba source code that references URLs starting with: | |
https://github.com/numpy/numpy | |
relates to use of/inclusion of/derivate work based on NumPy source code which | |
has the following license: |
?
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.
The numpy license is a BSD-3 not MIT. If the NumPy changelog readme has a different license, please attach a link to it.
Co-authored-by: stuartarchibald <stuartarchibald@users.noreply.github.com>
Comments that need addressing: |
As titled,
This PR adds towncrier as a Github workflow to check release notes for every PR. The action is intended to fail if there's no new release note, or skipped if there's a
skip_release_notes
label.