-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
MAINT: Use towncrier for release notes #12299
Conversation
looks good so far! One comment and one question:
|
This is what I was actually trying to ask about (sorry that wasn't clear). So asking again: how do we want to populate the "notable changes" section?
|
I think we can play it by ear / case-by-case. Generally I think (2) and (3) are better than (1). So far the case we do have is (2). |
I'd prefer (3), (1) is the worst option IMO. |
agreed! (2) would be acceptable for me, and then less technical+more verbose and high level would be good. |
I'm a big fan of option 2 |
I don't have time for a careful review of the code changes this morning, but I'm +1 to move ahead if CIs are green, you're satisfied with the config, and it follows #12233 (comment). |
* upstream/main: BUG: handle temporal discontinuities in Neuralynx `.ncs` files (mne-tools#12279) MAINT: Work around bad SciPy nightly wheels (mne-tools#12317) fix 404 link on devel landing page (mne-tools#12316) Switch from `epoch_data` to `data` for TFR array functions (mne-tools#12308) [pre-commit.ci] pre-commit autoupdate (mne-tools#12307) fix icon link colors (mne-tools#12301) Bump actions/download-artifact from 3 to 4 (mne-tools#12304) Bump github/codeql-action from 2 to 3 (mne-tools#12303) Bump actions/upload-artifact from 3 to 4 (mne-tools#12302)
* upstream/main: MAINT: Add bot entry [ci skip]
* upstream/main: MAINT: More [ci skip]
* upstream/main: MAINT: Use towncrier for release notes (mne-tools#12299) MAINT: More [ci skip] MAINT: Add bot entry [ci skip] BUG: handle temporal discontinuities in Neuralynx `.ncs` files (mne-tools#12279) MAINT: Work around bad SciPy nightly wheels (mne-tools#12317)
From the dev meeting today, we discussed a bit different options. @sappelhoff @agramfort you also commented in #11508 so I thought I'd bring your attention to this PR.
Towncrier was suggested by @drammock in #11508. Turns out that it's used by pip, pytest, and astropy, so should be well supported. Advantages relative to what we do now, all of which should make maintenance and contributing easier:
Minor arguable disadvantages:
newcontrib
no longer come first.However, all three of these are pretty easy to fix manually at release time, so I think we can live with them for the benefits.
I think it will be easy at release time to use
towncrier
directly to create adoc/changes/v1.7.rst
for example and remove the stubs fromdevel
, which is great as well.towncrier
wants to see files of the form<issue>.<type>.ext
, so at the end of the day we need for exampledoc/changes/devel/12345.enhancement.rst
. If you want to open a PR with an entry, currently you have to check to see what PR number you will get when you open by looking at the issues list, or open it then push your entry. With this PR, I'm going to write a little GitHub action (or improve the existing scientific-python one) so that you can just adddoc/changes/devel/enhancement.rst
and it will automaticallygit mv
this todoc/changes/devel/{{ github.event.number}}.enhancement.rst
for you!Todo before merge I think:
sphinxcontrib-towncrier
to populatedevel.rst
on the flyaction-towncrier-changelog
Separate PR:
doc/changes/devel/*.rst
filesCloses #12233
Closes #11508