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 release summary, some touch-ups #4217

Merged
merged 4 commits into from
Jul 23, 2020
Merged

Conversation

max-sixty
Copy link
Collaborator

This PR:

  • Proposes adding a Release Summary with a PR. This is something that maybe more people read than anything else we send, and yet it's the least reviewed text of anything I write; and I'm making guesses on what's important.
  • Proposes pasting the release summary into the GH Release page; to the extent people follow xarray by following our releases, it's nice to have something there.
  • Some touch-ups

Copy link
Member

@shoyer shoyer left a comment

Choose a reason for hiding this comment

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

Looks great, thanks Max!

Copy link
Collaborator

@keewis keewis left a comment

Choose a reason for hiding this comment

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

Looks good to me, too. I have a few suggestions, though:

Comment on lines 15 to 16
I (@max) find it helpful to use a PR given I'm not always familiar with all the
features of the release, and the summary is distributed widely.
Copy link
Collaborator

@keewis keewis Jul 12, 2020

Choose a reason for hiding this comment

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

I think it definitely makes sense to get a review of the summary so I'd remove this.

Instead, I'd like to suggest writing the summary as item 2, then opening a PR with the contributors, the summary and the whats-new.rst fixes (new item 4) as item 5 to get a chance for a review and once that is merged continue with the current item 4 (after syncing again).

So now we'd have:

  1. sync branch
  2. write summary
  3. get the contributors (also: what should happen in the rare case that the one releasing is not included in that list?)
  4. check whats-new.rst and the docs
  5. open a PR to add items 2 to 4 to whats-new.rst
  6. resync (should that be a new step or should that also be in item 5?)
  7. continue with the old item 4

Does that make sense?

@max-sixty
Copy link
Collaborator Author

Updated based on @keewis good suggestions. I haven't updated the numbers until we agree it's correct. (Maybe there's some plugin to do this? Lucky we don't have a 100 item list...)

@dcherian
Copy link
Contributor

Thanks @max-sixty

@dcherian dcherian merged commit 4e89331 into pydata:master Jul 23, 2020
dcherian added a commit to jacobtomlinson/xarray that referenced this pull request Jul 24, 2020
* upstream/master:
  Added xarrays-spatial and updated geoviews link (pydata#4262)
  update docs to point to xarray-contrib and xarray-tutorial (pydata#4252)
  Add release summary, some touch-ups (pydata#4217)
  CFTimeIndex calendar in repr (pydata#4092)
  fix the RTD timeouts (pydata#4254)
  update isort CI and pre-commit hook (pydata#4204)
@max-sixty max-sixty deleted the how-to-release branch July 26, 2020 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants