Skip to content
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

Merged
merged 6 commits into from
Jun 29, 2023
Merged

Added towncrier as a github workflow #8792

merged 6 commits into from
Jun 29, 2023

Conversation

kc611
Copy link
Contributor

@kc611 kc611 commented Mar 3, 2023

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.


* ``removal``: Signifying a deprecation or removal of public API.

* ``misc``: A ticket has been closed, but it is not of interest to users.
Copy link
Contributor Author

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.

Copy link
Contributor Author

@kc611 kc611 Mar 9, 2023

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.

Copy link
Contributor

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.

@kc611 kc611 marked this pull request as ready for review March 10, 2023 13:26
apmasell
apmasell previously approved these changes Mar 29, 2023
Copy link
Contributor

@apmasell apmasell left a 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

@kc611 kc611 added 5 - Ready to merge Review and testing done, is ready to merge and removed 3 - Ready for Review labels Mar 30, 2023
Copy link
Contributor

@stuartarchibald stuartarchibald left a 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/source/developer/contributing.rst Outdated Show resolved Hide resolved
docs/source/developer/contributing.rst Outdated Show resolved Hide resolved
docs/source/developer/contributing.rst Outdated Show resolved Hide resolved
Comment on lines 38 to 40
.. note::
This README was adapted from the NumPy changelog readme under the terms of
the MIT licence.
Copy link
Contributor

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

numba/LICENSES.third-party

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:

?

Copy link
Member

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.

docs/upcoming_changes/README.rst Outdated Show resolved Hide resolved
docs/upcoming_changes/README.rst Outdated Show resolved Hide resolved
docs/upcoming_changes/README.rst Outdated Show resolved Hide resolved
docs/upcoming_changes/README.rst Outdated Show resolved Hide resolved
@kc611 kc611 added needs triage/maintainer discussion For an issue/PR that needs discussion at a triage/maintainer meeting and removed 5 - Ready to merge Review and testing done, is ready to merge labels Mar 30, 2023
Co-authored-by: stuartarchibald <stuartarchibald@users.noreply.github.com>
@sklam sklam self-assigned this Apr 11, 2023
@sklam
Copy link
Member

sklam commented Apr 11, 2023

Comments that need addressing:

@sklam sklam added 4 - Waiting on author Waiting for author to respond to review and removed needs triage/maintainer discussion For an issue/PR that needs discussion at a triage/maintainer meeting labels Apr 11, 2023
@sklam sklam added 4 - Waiting on reviewer Waiting for reviewer to respond to author and removed 4 - Waiting on author Waiting for author to respond to review labels May 25, 2023
@sklam sklam removed their assignment May 25, 2023
@esc
Copy link
Member

esc commented Jun 5, 2023

@sklam are you happy with the changes from b3edecb ? -- if yes, can you approve this PR, plz, thank you.

@esc esc added this to the Numba 0.58 RC milestone Jun 27, 2023
@sklam sklam added 5 - Ready to merge Review and testing done, is ready to merge and removed 4 - Waiting on reviewer Waiting for reviewer to respond to author labels Jun 27, 2023
@esc esc merged commit 94361a2 into numba:main Jun 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Ready to merge Review and testing done, is ready to merge highpriority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants