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

Add draft release notes for v2.11.0rc1 #2414

Merged
merged 12 commits into from
May 13, 2024
Merged

Add draft release notes for v2.11.0rc1 #2414

merged 12 commits into from
May 13, 2024

Conversation

chrisbillowsMO
Copy link
Contributor

@chrisbillowsMO chrisbillowsMO commented May 9, 2024

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:

@chrisbillowsMO chrisbillowsMO self-assigned this May 9, 2024
@chrisbillowsMO chrisbillowsMO added this to the v2.11.0 milestone May 9, 2024
Copy link

codecov bot commented May 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.51%. Comparing base (66136df) to head (ac06fbf).

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.
📢 Have feedback on the report? Share it here.

@chrisbillowsMO chrisbillowsMO marked this pull request as ready for review May 9, 2024 08:04
Copy link
Contributor

@valeriupredoi valeriupredoi left a 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 😁

doc/changelog.rst Outdated Show resolved Hide resolved
doc/changelog.rst Outdated Show resolved Hide resolved
Copy link
Member

@bouweandela bouweandela left a 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?

Bug fixes
~~~~~~~~~

- Fixing missing height 2m coordinates in GFDL-CM4 and KIOST-ESM (:pull:`2294`) by :user:`Karen-A-Garcia`
Copy link
Member

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

Copy link
Contributor Author

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?

Copy link
Member

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.

Copy link
Contributor Author

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.

doc/changelog.rst Outdated Show resolved Hide resolved
doc/changelog.rst Outdated Show resolved Hide resolved
doc/changelog.rst Outdated Show resolved Hide resolved
doc/changelog.rst Outdated Show resolved Hide resolved
doc/changelog.rst Outdated Show resolved Hide resolved
doc/changelog.rst Outdated Show resolved Hide resolved
@chrisbillowsMO
Copy link
Contributor Author

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?

All Sphinx formatting should be fixed here: 65f9277

Copy link
Contributor

@valeriupredoi valeriupredoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking great 🍺

doc/changelog.rst Outdated Show resolved Hide resolved
doc/changelog.rst Outdated Show resolved Hide resolved
Installation
~~~~~~~~~~~~

- Updated iris pin to ``iris>=3.6.1`` (:pull:`2286`) by :user:`schlunma`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Updated iris pin to ``iris>=3.6.1`` (:pull:`2286`) by :user:`schlunma`

superseded by the PR on line 87

Copy link
Contributor Author

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?

Copy link
Member

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.

doc/changelog.rst Outdated Show resolved Hide resolved
Copy link
Member

@bouweandela bouweandela 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 making the changes! Feel free to merge now and do any fine tuning later.

@chrisbillowsMO
Copy link
Contributor Author

Hey look we did a thing! 😁🚀

https://esmvaltool--2414.org.readthedocs.build/projects/ESMValCore/en/2414/changelog.html#v2-11-0

@ehogan ehogan merged commit a51da92 into main May 13, 2024
5 checks passed
@ehogan ehogan deleted the 2413_draft_release_notes branch May 13, 2024 15:41
@chrisbillowsMO chrisbillowsMO restored the 2413_draft_release_notes branch May 14, 2024 14:40
@chrisbillowsMO chrisbillowsMO deleted the 2413_draft_release_notes branch May 14, 2024 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add draft release notes for v2.11.0rc1
4 participants