Changelog entry for v0.3.0 #887

willschlitzer · 2021-02-14T07:54:36Z

Description of proposed changes

Preview: https://pygmt-git-v030-release.gmt.vercel.app/changes.html

Previous release at #683

Changelog made by following the instructions at https://github.com/GenericMappingTools/pygmt/blob/master/MAINTENANCE.md#updating-the-changelog. The changelog itself includes the following sections:

New features
Enhancements
Documentation
Bug fixes
Maintenance
List of Contributors

TODO:

Format Pull Request links using sed -i.bak -E 's$$#([0-9]*)$$(`#\1 <https://github.com/GenericMappingTools/pygmt/pull/\1>`__)$g' changes.rst
Add Zenodo DOI link once it's reserved.
Add a new entry in doc/_static/version_switch.js for documentation switcher
Update citation information https://github.com/GenericMappingTools/pygmt#citing-pygmt
Set release date

Reminders

Run make format and make check to make sure the code follows the style guide.
Add tests for new features or tests that would have caught the bug that you're fixing.
Add new public functions/methods/classes to doc/api/index.rst.
Write detailed docstrings for all functions/methods.
If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

/format: automatically format and lint the code
/test-gmt-dev: run full tests on the latest GMT development version

weiji14

Hi @willschlitzer, assuming that you're learning from the previous release PR at #683 already. if you don't mind, could you edit the top post to follow that style (with checkboxes and all). We'll probably turn it into a proper template for #885 next time.

README.rst

weiji14 · 2021-02-14T08:48:39Z

Oh and by the way, I see that you've cleaned up the draft release notes at https://github.com/GenericMappingTools/pygmt/releases. Make sure you have a local backup, otherwise the release drafter bot will override your changes when we merge the last few PRs remaining for v0.3.0.

willschlitzer · 2021-02-14T09:29:03Z

@weiji14 It's backed up!

README.rst

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Co-Authored-By: Will Schlitzer <willschlitzer@users.noreply.github.com>

README.rst

weiji14 · 2021-02-15T01:47:20Z

doc/changes.rst

+
+Highlights
+
+*


We'll need to add 3 to 4 lines for the highlights section here. How about:

Suggested change

*

* 🎉 **Third minor release of PyGMT** 🎉

* Wrap inset (#788) for making overview maps and subplot (#822) for multi-panel figures

* Apply standardized formatting conventions (#775) across most documentation pages

* Drop Python 3.6 support (#699) so PyGMT now requires Python 3.7 or newer

Feel free to suggest edits in the wording. I'm also thinking whether to mention the upcoming drop in support for GMT 6.1.1 (once GMT 6.2.0 is out, something for PyGMT v0.4.0) and/or NEP29 adoption (#690). Might depend on whether we want a v0.3.1 release?

I'm also thinking whether to mention the upcoming drop in support for GMT 6.1.1 (once GMT 6.2.0 is out, something for PyGMT v0.4.0) and/or NEP29 adoption

Don't try to predict the future. 😄

Ok, will surprise our users then 😸

weiji14 · 2021-02-15T01:55:49Z

doc/changes.rst

+
+Contributors
+
+@liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer


Suggested change

@liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer

People with a "+" by their name contributed a patch for the first time.

* `Dongdong Tian <https://github.com/seisman>`__

* `Liam Toney <https://github.com/liamtoney>`__

* `Meghan Jones <https://github.com/meghanrjones>`__ +

* `Michael Grund <https://github.com/michaelgrund>`__ +

* `Wei Ji Leong <https://github.com/weiji14>`__

* `Will Schlitzer <https://github.com/willschlitzer>`__ +

Two thoughts here:

Should we sort alphebetically by name (as above), or by number of commits (old style before).

Some projects (e.g. geopandas) add a little note with a plus (+) to indicate people's first contribution, should we add it here?

Two thoughts here:

Should we sort alphebetically by name (as above), or by number of commits (old style before).

I'm fine with both, but prefer "number of commits".

Some projects (e.g. geopandas) add a little note with a plus (+) to indicate people's first contribution, should we add it here?

I saw it in many projects, but is there an easy way to know if someone makes his/her first contribution to this release?

Some projects (e.g. geopandas) add a little note with a plus (+) to indicate people's first contribution, should we add it here?

I saw it in many projects, but is there an easy way to know if someone makes his/her first contribution to this release?

Other than remembering people, there's probably a complicated git command that could do it. Happy to leave it without the plus.

I'm fine with both, but prefer "number of commits".

I thought your name would be on top either way, but git shortlog HEAD...v0.2.1 -sne gives:

58 Will Schlitzer <schlitzer90@gmail.com> 54 Dongdong Tian <seisman.info@gmail.com> 9 Wei Ji <23487320+weiji14@users.noreply.github.com> 7 Michael Grund <michael_grund@gmx.de> 6 dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 3 Liam Toney <38269494+liamtoney@users.noreply.github.com> 3 Meghan Jones <meghanj@hawaii.edu> 3 Wei Ji <weiji.leong@vuw.ac.nz>

and so the order would be:

Suggested change

@liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer

* `Will Schlitzer <https://github.com/willschlitzer>`__

* `Dongdong Tian <https://github.com/seisman>`__

* `Wei Ji Leong <https://github.com/weiji14>`__

* `Michael Grund <https://github.com/michaelgrund>`__

* `Liam Toney <https://github.com/liamtoney>`__

* `Meghan Jones <https://github.com/meghanrjones>`__

Looks better to me.

Alright, I'll commit the change, but we should document this (order by number of commits) for when we deal with #885.

Running git shortlog HEAD...v0.2.1 -sne on the master branch gives me:

54 Dongdong Tian <seisman.info@gmail.com> 54 Will Schlitzer <schlitzer90@gmail.com> 9 Wei Ji <23487320+weiji14@users.noreply.github.com> 7 Michael Grund <michael_grund@gmx.de> 6 dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 3 Liam Toney <38269494+liamtoney@users.noreply.github.com> 3 Meghan Jones <meghanj@hawaii.edu>

Not trying to be listed at the top, just curious why our results are different 😂

Hmm, I was probably on a different branch (which explains why it had my unversity vuw.ac.nz email). I think you'll get bumped down after @willschlitzer merges this PR though 🤣

Dare I suggest that as a GMT developer and long-time PyGMT maintainer, I think @seisman has definitely earned the first spot!

doc/changes.rst

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

doc/changes.rst

weiji14 · 2021-02-15T08:25:05Z

Format Pull Request links using sed -i.bak -E 's$(#([0-9]*))$(#\1 <https://github.com/GenericMappingTools/pygmt/pull/\1>__)$g' changes.rst

Also, are you able to run sed? If not I can do it for you.

willschlitzer · 2021-02-15T08:27:54Z

Format Pull Request links using sed -i.bak -E 's$(#([0-9]*))$(#\1 <https://github.com/GenericMappingTools/pygmt/pull/\1>__)$g' changes.rst

Also, are you able to run sed? If not I can do it for you.

Forgot about that one! Just ran it and pushed the change

weiji14

Sorry, noticed a few more missing stuff at https://pygmt-git-v030-release.gmt.vercel.app/changes.html#release-v0-3-0-2021-02-15.

doc/changes.rst

weiji14

Ok, manually updating two lines for now to be comma (,) separated, because I can't be bothered to learn sed in a rush. Hopefully this is the last 🤞

doc/changes.rst

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

willschlitzer · 2021-02-15T09:08:14Z

Ok, manually updating two lines for now to be comma (,) separated, because I can't be bothered to learn sed in a rush. Hopefully this is the last crossed_fingers

Hoping for that too!

doc/changes.rst

Third minor release of PyGMT. * Add v0.3.0 to version_switch.js * Update citation information * Update compatibility and documentation links * Initial draft changelog from Release Drafter * Merge some changelog entries together * Add highlights and list out contributor names ordered by no. of commits * Group changes in the "Maintenance" section * Group changes in the 'Documentation' section and update some titles * Run sed command to format links; format fixes Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> Co-authored-by: Dongdong Tian <seisman.info@gmail.com> Co-authored-by: Will Schlitzer <willschlitzer@users.noreply.github.com>

willschlitzer added 2 commits February 14, 2021 07:40

Add v0.3.0 to version_switch.js

ccb9aa8

Update citation information

9fe24fb

willschlitzer added the skip-changelog Skip adding Pull Request to changelog label Feb 14, 2021

weiji14 reviewed Feb 14, 2021

View reviewed changes

README.rst Show resolved Hide resolved

weiji14 added this to the 0.3.0 milestone Feb 14, 2021

weiji14 mentioned this pull request Feb 14, 2021

Update the release drafter workflow and configurations #885

Closed

4 tasks

Update compatibility and doicumentation links

1081fb2

vercel bot temporarily deployed to Preview February 14, 2021 09:49 Inactive

seisman reviewed Feb 14, 2021

View reviewed changes

README.rst Outdated Show resolved Hide resolved

Apply suggestions from code review

6ec6a3a

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

vercel bot temporarily deployed to Preview February 14, 2021 18:36 Inactive

weiji14 mentioned this pull request Feb 14, 2021

Release PyGMT v0.3.0 #845

Closed

19 tasks

weiji14 changed the title ~~V0.3.0 release~~ Changelog entry for v0.3.0 Feb 14, 2021

weiji14 and others added 3 commits February 15, 2021 12:45

Merge branch 'master' into v0.3.0-release

fc21cb8

Initial draft changelog from Release Drafter

36b72e9

Merge some changelog entries together

29cbefc

Co-Authored-By: Will Schlitzer <willschlitzer@users.noreply.github.com>

vercel bot temporarily deployed to Preview February 15, 2021 00:23 Inactive

weiji14 reviewed Feb 15, 2021

View reviewed changes

seisman reviewed Feb 15, 2021

View reviewed changes

Apply suggestions from code review

4122c73

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

vercel bot temporarily deployed to Preview February 15, 2021 02:58 Inactive

Add highlights and list out contributor names ordered by no. of commits

6d0208d

vercel bot temporarily deployed to Preview February 15, 2021 03:45 Inactive

seisman reviewed Feb 15, 2021

View reviewed changes

doc/changes.rst Outdated Show resolved Hide resolved

seisman reviewed Feb 15, 2021

View reviewed changes

doc/changes.rst Outdated Show resolved Hide resolved

seisman reviewed Feb 15, 2021

View reviewed changes

doc/changes.rst Show resolved Hide resolved

doc/changes.rst Outdated Show resolved Hide resolved

Group changes in the "Maintenance" section

e944f1d

vercel bot temporarily deployed to Preview February 15, 2021 04:11 Inactive

willschlitzer requested review from weiji14 and seisman February 15, 2021 08:17

willschlitzer added 2 commits February 15, 2021 08:27

Run sed command to format links

a98ca1e

Merge remote-tracking branch 'origin/v0.3.0-release' into v0.3.0-release

32047f9

vercel bot temporarily deployed to Preview February 15, 2021 08:28 Inactive

weiji14 reviewed Feb 15, 2021

View reviewed changes

doc/changes.rst Outdated Show resolved Hide resolved

doc/changes.rst Outdated Show resolved Hide resolved

Run sed command to format links; format fixes

98097bc

vercel bot temporarily deployed to Preview February 15, 2021 08:52 Inactive

format fixes

23bf843

vercel bot temporarily deployed to Preview February 15, 2021 09:00 Inactive

weiji14 requested changes Feb 15, 2021

View reviewed changes

doc/changes.rst Outdated Show resolved Hide resolved

doc/changes.rst Outdated Show resolved Hide resolved

Apply suggestions from code review

dae9804

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

vercel bot temporarily deployed to Preview February 15, 2021 09:08 Inactive

weiji14 reviewed Feb 15, 2021

View reviewed changes

doc/changes.rst Outdated Show resolved Hide resolved

Fix a typo

8a20f3a

weiji14 approved these changes Feb 15, 2021

View reviewed changes

vercel bot temporarily deployed to Preview February 15, 2021 09:16 Inactive

weiji14 merged commit 65b099a into master Feb 15, 2021

weiji14 deleted the v0.3.0-release branch February 15, 2021 09:23

weiji14 restored the v0.3.0-release branch February 15, 2021 11:42

weiji14 deleted the v0.3.0-release branch February 15, 2021 11:56

weiji14 mentioned this pull request Feb 16, 2021

Update release process in template post v0.3.0 #907

Merged

5 tasks

weiji14 mentioned this pull request Mar 9, 2021

Release PyGMT v0.3.1 #987

Closed

23 tasks

willschlitzer mentioned this pull request Mar 13, 2021

Changelog entry for v0.3.1 release #1047

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changelog entry for v0.3.0 #887

Changelog entry for v0.3.0 #887

willschlitzer commented Feb 14, 2021 •

edited

Loading

weiji14 left a comment

weiji14 commented Feb 14, 2021

willschlitzer commented Feb 14, 2021 •

edited

Loading

weiji14 Feb 15, 2021

seisman Feb 15, 2021 •

edited

Loading

weiji14 Feb 15, 2021

weiji14 Feb 15, 2021

seisman Feb 15, 2021

weiji14 Feb 15, 2021

seisman Feb 15, 2021

weiji14 Feb 15, 2021

seisman Feb 15, 2021

weiji14 Feb 15, 2021

willschlitzer Feb 15, 2021

weiji14 commented Feb 15, 2021

willschlitzer commented Feb 15, 2021

weiji14 left a comment

weiji14 left a comment

willschlitzer commented Feb 15, 2021

-*
+* 🎉 **Third minor release of PyGMT** 🎉
+* Wrap inset (#788) for making overview maps and subplot (#822) for multi-panel figures
+* Apply standardized formatting conventions (#775) across most documentation pages
+* Drop Python 3.6 support (#699) so PyGMT now requires Python 3.7 or newer


		Contributors

		@liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer

-@liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer
+People with a "+" by their name contributed a patch for the first time.
+* `Dongdong Tian <https://github.com/seisman>`__
+* `Liam Toney <https://github.com/liamtoney>`__
+* `Meghan Jones <https://github.com/meghanrjones>`__ +
+* `Michael Grund <https://github.com/michaelgrund>`__ +
+* `Wei Ji Leong <https://github.com/weiji14>`__
+* `Will Schlitzer <https://github.com/willschlitzer>`__ +


		Highlights

		*

Changelog entry for v0.3.0 #887

Changelog entry for v0.3.0 #887

Conversation

willschlitzer commented Feb 14, 2021 • edited Loading

weiji14 left a comment

Choose a reason for hiding this comment

weiji14 commented Feb 14, 2021

willschlitzer commented Feb 14, 2021 • edited Loading

Choose a reason for hiding this comment

seisman Feb 15, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weiji14 commented Feb 15, 2021

willschlitzer commented Feb 15, 2021

weiji14 left a comment

Choose a reason for hiding this comment

weiji14 left a comment

Choose a reason for hiding this comment

willschlitzer commented Feb 15, 2021

willschlitzer commented Feb 14, 2021 •

edited

Loading

willschlitzer commented Feb 14, 2021 •

edited

Loading

seisman Feb 15, 2021 •

edited

Loading