docs: adopt towncrier changelog#7166
Conversation
There was a problem hiding this comment.
Templating
This PR includes changes that may be worth sharing via templating. For each file listed below, please either:
- Action the suggestion via a pull request editing/adding the relevant file in the SciTools/.github
templates/directory. 1 - Raise an issue against the SciTools/.github repo for the above action if you really don't have 10mins spare right now. Include an assignee, to avoid it being forgotten.
- Dismiss the suggestion if the changes are not suitable for templating.
You will need to dismiss this review before this PR can be merged. Recommend the reviewer does this as their final action before merging, as this text will continually update as commits come in.
Templated files
The following changed files are templated:
-
MANIFEST.in, templated bySciTools/.github/templates/MANIFEST.in -
pyproject.toml, templated bySciTools/.github/templates/pyproject.toml
Template candidates
The following changed files are not currently templated, but their parent directories suggest they may be good candidates for a new template to be created:
Footnotes
-
Include this text in the PR body to avoid any notifications about applying the template changes back to the source repo!
@scitools-templating: please no update notification on: iris↩
⏱️ Performance Benchmark Report: 0bf4d74Performance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: 1db1011Performance shiftsFull benchmark resultsGenerated by GHA run |
I guess you can't avoid updating the lockfiles, so the new matplotlib thing is inevitably in the way here. Is it possible to create a workflow check for a new fragment with every PR ? |
I'm going to leave that as a follow-on PR 👍 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7166 +/- ##
=======================================
Coverage 90.15% 90.15%
=======================================
Files 91 91
Lines 24983 24983
Branches 4685 4685
=======================================
Hits 22524 22524
Misses 1682 1682
Partials 777 777 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
⏱️ Performance Benchmark Report: 3403066Performance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: abda11bPerformance shiftsFull benchmark resultsGenerated by GHA run |
Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com>
|
@tkknight Awesome! Thanks 🎉 |
⏱️ Performance Benchmark Report: d21659aPerformance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: 2e7ef83Performance shiftsFull benchmark resultsGenerated by GHA run |
Description
This pull-request migrates to using
towncrierfor managing development and release changelogs.By its nature, this pull-request will go stale quickly. Additionally, this pull-request is noisy and will cause disruption to other open pull-requests.
I've intentionally not updated the
donothingscript. However, I have banked the general process within the docs, which will serve as a template for the future changes to thedonothingscript. This should be done as a follow-on task.I recommend that we first need to understand and agree on the new changelog process - so I'm separating concerns here to expedite this PR getting banked.
TODO:
matplotlib <3.11andpytest <9.1to avoid known failuresdonothingscript to encode new changelog process once its agreed and establishedrelease_do_nothing.pyfortowncrierchangelog #7169towncrierchangelog news fragment quality assurance #7170towncrierchangelog process for point (patch) releases #7171