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

Integrated whatsnew for v3.1 release (rc0) #4285

Merged
merged 6 commits into from Aug 17, 2021
Merged

Conversation

pp-mo
Copy link
Member

@pp-mo pp-mo commented Aug 17, 2021

🚀 Pull Request

Description

I think this replicates the way we have done it in the past : the "interim" separate whatsnew files 3.0..rst are combined into a single 3.1.rst covering all history since 3.0
My only precedent for this is what we did at v2.2.1


Consult Iris pull request check list

@pp-mo pp-mo added this to the v3.1.0 milestone Aug 17, 2021
@pp-mo pp-mo requested a review from lbdreyer August 17, 2021 12:03
@pp-mo pp-mo added this to In Progress in Iris v3.1.0 via automation Aug 17, 2021
@pp-mo pp-mo changed the base branch from main to v3.1.x August 17, 2021 12:03
@@ -103,7 +103,7 @@ def callback(cube, field, filename):


# Iris revision.
__version__ = "3.1.dev0"
__version__ = "3.1.0rc0"
Copy link
Member

Choose a reason for hiding this comment

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

I'm confused by this diff. You already changed the version string yesterday. The 3.1.x branch already has 3.1.0rc0(https://github.com/SciTools/iris/blob/v3.1.x/lib/iris/__init__.py#L106) so why is this trying to change is again?

Copy link
Member

Choose a reason for hiding this comment

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

I see there are some conflicting files. Maybe try rebasing onto the 3.1.x branch ?

Copy link
Member Author

@pp-mo pp-mo Aug 17, 2021

Choose a reason for hiding this comment

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

Sorry, I used the previous branch, so I think it's the probably squash+merge. I'll rebase onto 3.1.x

Copy link
Member Author

Choose a reason for hiding this comment

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

.. yes, I think that fixed it

@pp-mo
Copy link
Member Author

pp-mo commented Aug 17, 2021

@lbdreyer sorry, it looks like I failed to bring some links across.
I will rebuild + run checks locally this time.
Just fixing that ...

Internal changes in v3.0.2 (27 May 2021)
========================================

#. `@jamesp`_ updated a test to the latest numpy version (:pull:`3977`) [``pre-v3.1.0``]
Copy link
Member

Choose a reason for hiding this comment

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

should these still have the pre-v3.1.0 ?

Copy link
Member

Choose a reason for hiding this comment

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

Maybe include the note

   Note that, the above contributions labelled with ``pre-v3.1.0`` are part of the forthcoming
   Iris v3.1.0 release, but require to be included in this patch release.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good spot !
I hadn't properly understood what these were there for.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it means that these entries should be in the 'main' release part, not the bugfix sections.
Doing that now.

#. `@rcomer`_ modified test modules so they run consistently under ``pytest`` and
``nose``, and also fixed some minor issues with :class:`~iris.time.PartialDateTime`.
(:pull:`4249`)

Copy link
Member

Choose a reason for hiding this comment

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

You have lost the note:

   Note that, we are forced to drop support for ``Python 3.6`` in this patch due to
   the third-party package dependencies required by (:pull:`4222`).

?

Copy link
Member Author

@pp-mo pp-mo Aug 17, 2021

Choose a reason for hiding this comment

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

There is a note about this in the release highlights, so I thought that might be enough.
I don't think we really need to explain why : this note in the bugfix release was only there because it had changed requirements from the original v3.0.0. But now we are on to a new minor release that's no big deal.

docs/src/whatsnew/3.1.rst Outdated Show resolved Hide resolved
3.0.4.rst
3.0.3.rst
3.0.2.rst
3.0.1.rst
Copy link
Member

Choose a reason for hiding this comment

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

@pp-mo Do you know why we had separate what's news for each bug release?
Was it just there to draw attention to the fact that there multiple 3.0.x releases?

Copy link
Member Author

@pp-mo pp-mo Aug 17, 2021

Choose a reason for hiding this comment

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

I don't know really.
However, I did find that we did not do this with the 2.2.1 bugfix release : there we just have a modified 2.2.rst (and no 2.2.1.rst)

Copy link
Member Author

Choose a reason for hiding this comment

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

Also, the 3.0.4.rst incorporates all the entries from the other 3

Copy link
Member

@lbdreyer lbdreyer 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 all your work on this @pp-mo!
Once the CI is finished, I'll merge this in...

Iris v3.1.0 automation moved this from In Progress to In Review Aug 17, 2021
|iris_version| |build_date|
***************************
v3.1 (17 Aug 2021) [unreleased]
*******************************
Copy link
Member

Choose a reason for hiding this comment

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

I notice for the Iris 3 rc we included a date:
https://scitools-iris.readthedocs.io/en/v3.0.0rc0/whatsnew/3.0.html

Copy link
Member

Choose a reason for hiding this comment

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

Sorry wasn't clear. I meant to say just a date no unreleased

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, I think that's effectively a preliminary date -- the date of the RC.
Which we would change again we we make it a full release
(imho)

Copy link
Member Author

Choose a reason for hiding this comment

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

I've done the same, but left in the '[unreleased]' tag, because I thought that made sense..

Copy link
Member Author

Choose a reason for hiding this comment

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

You might also consider that it makes sense to label this with the 'rc0',
but, again, we haven't done so in the past

@lbdreyer lbdreyer merged commit c58a592 into SciTools:v3.1.x Aug 17, 2021
Iris v3.1.0 automation moved this from In Review to Done Aug 17, 2021
tkknight added a commit to tkknight/iris that referenced this pull request Sep 19, 2021
* main: (71 commits)
  Skip TestConstrainedLoad if data missing (SciTools#4319)
  Add 'Good First Issue' label to reasons an issue doesn't go stale (SciTools#4317)
  Gallery: simplify quiver example (SciTools#4120)
  Improve styling in a minor way in docs (SciTools#4314)
  bump version (SciTools#4310)
  Made clear we only test on Linux. (SciTools#4309)
  Updated environment lockfiles (SciTools#4308)
  Include Discussions in Getting Involved. (SciTools#4307)
  Fixed text to show as link. (SciTools#4305)
  [pre-commit.ci] pre-commit autoupdate (SciTools#4299)
  Updated environment lockfiles (SciTools#4298)
  cartopy feature download (SciTools#4304)
  Mesh Loading (AVD-1813) (SciTools#4262)
  reset whatsnew latest (SciTools#4288)
  Updated environment lockfiles (SciTools#4289)
  Update cube.py (SciTools#4287)
  Integrated whatsnew for v3.1 release (rc0) (SciTools#4285)
  Version changes and final whatsnew tweaks for 3v1rc0. (SciTools#4284)
  Missing whatsnew entries for 3.1 release. (SciTools#4283)
  Update CF standard name table to v77 (SciTools#4282)
  ...
@lbdreyer lbdreyer mentioned this pull request Jan 26, 2022
16 tasks
@pp-mo pp-mo deleted the v3x1_rc branch April 28, 2023 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Iris v3.1.0
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants