-
Notifications
You must be signed in to change notification settings - Fork 39
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
Add draft release notes for v2.11.0rc1 #2414
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2414 +/- ##
=======================================
Coverage 94.51% 94.51%
=======================================
Files 246 246
Lines 14020 14020
=======================================
Hits 13251 13251
Misses 769 769 ☔ View full report in Codecov by Sentry. |
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 good, Chris! Just a couple minor suggestions from me - no need to include me swearwords in the Changelog 😁
Co-authored-by: Valeriu Predoi <[email protected]>
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 good already! Could you make the names of preprocessor functions links, e.g. replace regrid_time by
:func:`esmvalcore.preprocessor.regrid_time`
etc? And take care to make monospace strings render like that, i.e. use double backtics instead of single ones?
doc/changelog.rst
Outdated
Bug fixes | ||
~~~~~~~~~ | ||
|
||
- Fixing missing height 2m coordinates in GFDL-CM4 and KIOST-ESM (:pull:`2294`) by :user:`Karen-A-Garcia` |
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.
This should be in the 'Fixes for datasets' section
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.
Fixed here: 657b459
The Fixes for datasets
label was on the PR. Is it worth updating the script to have a second set of prioritised labels that are used in the groupings?
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! I wouldn't put too much effort in updating the script. The @ESMValGroup/technical-lead-development-team actually agreed to try out towncrier instead some time ago because the current changelog is not great for users and difficult to populate for release managers who are not up-to-date with everything that happened in the project over the past few months.
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.
Oh great! Thanks for letting us know.
All Sphinx formatting should be fixed here: 65f9277 |
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 great 🍺
Installation | ||
~~~~~~~~~~~~ | ||
|
||
- Updated iris pin to ``iris>=3.6.1`` (:pull:`2286`) by :user:`schlunma` |
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.
- Updated iris pin to ``iris>=3.6.1`` (:pull:`2286`) by :user:`schlunma` |
superseded by the PR on line 87
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.
But poor @schlunma won't get the deserved credit for all his good work! Would it be ok to leave it please?
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 changelog is intended for users of the tool, so they can quickly see what changed between releases. Mentioning aan outdated change is confusing to them, eg n this case they might think the new version works with Iris 3.6, while in reality it requires at least 3.8.
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 making the changes! Feel free to merge now and do any fine tuning later.
…ValCore into 2413_draft_release_notes
Hey look we did a thing! 😁🚀 https://esmvaltool--2414.org.readthedocs.build/projects/ESMValCore/en/2414/changelog.html#v2-11-0 |
Description
Closes #2413.
Before you get started
Checklist
It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.
To help with the number pull requests: