Release PyGMT v0.4.1

[core-man]

Release: v0.4.1
Scheduled Date: 2021/08/07
Pull request due date: 2021/08/05

Priority PRs/issues to complete prior to release

• Change references from "master" branch to "main" branch #1360
• Add gallery example for grdclip #1396
• Remove the "documentation for other versions" section from the README file #1358
• Add common option aliases to COMMON_OPTIONS in decorators.py #1407

Before release:

• Reserve a DOI on Zenodo by clicking on "New Version" @weiji14
• Finish up 'Changelog entry for v0.x.x' Pull Request: @core-man
  • Add a new entry in doc/_static/version_switch.js for documentation switcher
  • Update citation information https://github.com/GenericMappingTools/pygmt#citing-pygmt
  • Add the documentation link https://github.com/GenericMappingTools/pygmt#compatibility-with-gmtpythonnumpy-versions
  • Add compatibility information https://github.com/GenericMappingTools/pygmt#compatibility-with-gmtpythonnumpy-versions
  • Copy draft changelog from Release Drafter and edit it to look nice (see maintainers guide for details)

Release:

• At the PyGMT release page on GitHub: (@core-man)
  • Edit the draft release notes with the finalized changelog
  • Set the tag version and release title to vX.Y.Z
  • Make a release by clicking the 'Publish Release' button, this will automatically create a tag too
• Manually upload the pygmt-vX.Y.Z.zip and baseline-images.zip files to https://zenodo.org/deposit, ensure that it is filed under the correct reserved DOI

After release:

• Update conda-forge pygmt-feedstock [Usually done automatically by conda-forge's bot] pygmt v0.4.1 conda-forge/pygmt-feedstock#18
• Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) Bump to PyGMT v0.4.1 try-gmt#27
• Announce the release on:
  • GMT forum (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status) @michaelgrund
  • [x] [Major/Minor releases only] GMT website (News)
  • ResearchGate (after forum announcement) @core-man
  • Twitter (after forum announcement) https://twitter.com/gmt_dev/status/1425212858380349441

---

• Party 🎉 (don't tick before all other checkboxes are ticked!)

[maxrjones]

This was a last minute PR with a lot of text, so I understand if it's not possible, but otherwise it would be helpful to have #1407 reviewed for v0.4.1 in order to add more good first issues.

[weiji14]

I've reserved a DOI on Zenodo 10.5281/zenodo.5162003 for PyGMT v0.4.1. Feel free to start drafting the changelog @core-man!

[maxrjones]

Do we want #1358 finished for v0.4.1 or wait until after? I can submit a PR if it's important to include, but do not have a preference about timing.

[core-man]

Do we want #1358 finished for v0.4.1 or wait until after? I can submit a PR if it's important to include, but do not have a preference about timing.

I think you could submit a PR to finish it for v0.4.1. Good first issues can still be found after v0.4.1.

[core-man]

I have drafted release news on https://hackmd.io/@pygmt/v0-4-1_announcement using v0.4.0 as a template. Please help polish it 😄 if possible.

[michaelgrund]

I have drafted release news on https://hackmd.io/@pygmt/v0-4-1_announcement using v0.4.0 as a template. Please help polish it 😄 if possible.

Made a few adjustments and added a comment regarding the ESWN dates.

[weiji14]

Can you see and edit the draft v0.4.1 release on https://github.com/GenericMappingTools/pygmt/releases @core-man? If not, we might need to get a maintainer like @michaelgrund to do the GitHub release/tag step.

[core-man]

Can you see and edit the draft v0.4.1 release on https://github.com/GenericMappingTools/pygmt/releases @core-man? If not, we might need to get a maintainer like @michaelgrund to do the GitHub release/tag step.

Yes, I can edit it, and am doing it now.

[core-man]

Set the tag version and release title to vX.Y.Z

I find release drafter will automatically set the tag version and release title so that we could add a note for this step (good first issue)?

---

See #1414 (comment):

Sounds good. Just want to make the 7 Aug 2021 deadline (specifically before it turns 8 Aug at UTC).

Do we want to set a default and exact time in UTC time for merging a changelog entry PR so that everyone is okay with that time and knows when we will merge the PR? Of course, it could be changed case by case.

[weiji14]

Great work @core-man! Zenodo DOI now works at https://doi.org/10.5281/zenodo.5162003 🎉

Set the tag version and release title to vX.Y.Z

I find release drafter will automatically set the tag version and release title so that we could add a note for this step (good first issue)?

Yes it should be set to vX.Y.Z automatically. The main thing is to make sure that there is a v, so maybe we can change the wording of that step a little bit to clarify that?

See #1414 (comment):

Sounds good. Just want to make the 7 Aug 2021 deadline (specifically before it turns 8 Aug at UTC).

Do we want to set a default and exact time in UTC time for merging a changelog entry PR so that everyone is okay with that time and knows when we will merge the PR? Of course, it could be changed case by case.

Yeah, the timezone hasn't always been very clear in past releases, so we can be more explicit that the date refers to UTC. I think as long as we merge the changelog PR when it is still the day on UTC time (i.e. 7 Aug in this case) it should be fine.

I'm heading to bed now, but will help out with the rest of the post-release tasks tomorrow (8 Aug NZST).

[core-man]

I'm heading to bed now, but will help out with the rest of the post-release tasks tomorrow (8 Aug NZST).

Thanks for your help~~~ Have a good sleep.

Yes it should be set to vX.Y.Z automatically. The main thing is to make sure that there is a v, so maybe we can change the wording of that step a little bit to clarify that?

Good. I will submit an issue later to suggest revising it to be something like:

Make sure that the tag version and release title are automatically set to vX.Y.Z [there is a v]

[weiji14]

Ok, conda package is published, and try-gmt has been updated (thanks @seisman)! What's left should be just the announcements.

I have drafted release news on https://hackmd.io/@pygmt/v0-4-1_announcement using v0.4.0 as a template. Please help polish it smile if possible.

Made a few adjustments and added a comment regarding the ESWN dates.

I've added in some new figures (gallery, team gallery, AGU abstract image) and moved a few things here and there. Let's wait for @meghanrjones to get back on Monday before posting this, I'm also interested on the ESWN workshop details.

Yes it should be set to vX.Y.Z automatically. The main thing is to make sure that there is a v, so maybe we can change the wording of that step a little bit to clarify that?

Good. I will submit an issue later to suggest revising it to be something like:

Make sure that the tag version and release title are automatically set to vX.Y.Z [there is a v]

👍. Also feel free to suggest other things you felt could be done to make the release process smoother (see similar previous PRs at #1346, #907).

[michaelgrund]

Except the open point regarding ESWN it looks good to me 😉.

[maxrjones]

I added a comment on the hackmd draft in response to the ESWN workshop item, explaining that the original plan was to open the registration to all applicants. While we discuss if/how to make it even more open, I have generalized the bullet point to reflect that people can expect the final information through the Forum/Twitter.

[seisman]

The v0.4.1 announcement looks good to me.

[core-man]

The v0.4.1 announcement looks great~ 😄

[michaelgrund]

Looks good to me. Do we want to share it across all our communication channels today?

[seisman]

Looks good to me. Do we want to share it across all our communication channels today?

@michaelgrund I think you already have the permission to make posts in the "Announcement" cateorgy, right? Do you want to do it this time?

[michaelgrund]

Looks good to me. Do we want to share it across all our communication channels today?

@michaelgrund I think you already have the permission to make posts in the "Announcement" cateorgy, right? Do you want to do it this time?

Made the announcement in the forum.

[core-man]

The announcement has been made at ResearchGate.

[weiji14]

Looks good to me. Do we want to share it across all our communication channels today?

@michaelgrund I think you already have the permission to make posts in the "Announcement" cateorgy, right? Do you want to do it this time?

Made the announcement in the forum.

Thanks @michaelgrund! Tweet is also up at https://twitter.com/gmt_dev/status/1425212858380349441. Could you do the announcement on ResearchGate please @core-man and we should be able to close this issue 😁

[seisman]

🥳 Nice teamwork! Close the issue and move on to the next release!