From 2e0ddd0992abf9fc2f144fc912cbb3cadf403d84 Mon Sep 17 00:00:00 2001 From: Wei Ji Date: Sun, 5 Jul 2020 15:57:08 +1200 Subject: [PATCH 1/8] Changelog entry for v0.1.2 Patch release in preparation for the Scipy 2020 sprint session. --- README.rst | 2 ++ doc/changes.rst | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+) diff --git a/README.rst b/README.rst index f641201c974..f20a8d9d59a 100644 --- a/README.rst +++ b/README.rst @@ -171,5 +171,7 @@ Documentation for other versions * `Development `__ (reflects the *master* branch on Github) * `Latest release `__ +* `v0.1.2 `__ +* `v0.1.1 `__ * `v0.1.0 `__ * `v0.0.1a0 `__ diff --git a/doc/changes.rst b/doc/changes.rst index 143b4829d68..786d2a564bb 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -1,6 +1,53 @@ Changelog ========= +Release v0.1.2 (2020/07/XX) +--------------------------- + +Highlights: + +* Patch release in preparation for the Scipy 2020 sprint session +* Last version to support GMT 6.0, future PyGMT versions will require GMT 6.1 or newer + +New Features: + +* Wrap grdcut (#492) @seisman +* Add show_versions() function for printing debugging information used in issue reports (#466) @seisman + +Enhancements: + +* Change load_earth_relief()'s default resolution to 01d (#488) @seisman +* Enhance text with extra functionality and aliases (#481) @weiji14 + +Documentation: + +* Add gallery example for grdview (#502) @liamtoney +* Turn all short aliases into long form (#474) @weiji14 +* Update the plotting example using the colormap generated by pygmt.makecpt (#472) @seisman +* Add instructions to view the test coverage reports locally (#468) @seisman +* Update the instructions for testing pygmt install (#459) @seisman + +Bug Fixes: + +* Fix a bug when passing data to GMT in Session.open_virtual_file() (#490) @seisman + +Maintenance: + +* Fix several failures due to updates of earth relief data (#498) @seisman +* Unpin pylint version and fix some lint warnings (#484) @weiji14 +* Separate tests of gmtinfo and grdinfo (#461) @seisman +* Fix the test for GMT_COMPATIBILITY=6 (#454) @seisman +* Update baseline images for updates of earth relief data (#452) @seisman +* Simplify PyGMT Release process (#446) @weiji14 + +This release contains contributions from: + +* Dongdong Tian `(@seisman) `__ +* Wei Ji Leong `(@weiji14) `__ +* Liam Toney `(@liamtoney) `__ + +---- + Release v0.1.1 (2020/05/22) --------------------------- From 64e22ef09a1ee88cb70a061395698419f45704ce Mon Sep 17 00:00:00 2001 From: Wei Ji Date: Sun, 5 Jul 2020 16:26:09 +1200 Subject: [PATCH 2/8] Add changelog entry for temporary xfail workaround on grd tests --- doc/changes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/changes.rst b/doc/changes.rst index 786d2a564bb..d243035b253 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -33,6 +33,7 @@ Bug Fixes: Maintenance: +* Temporarily expect failures for some grdcontour and grdview tests (#503) @weiji14 * Fix several failures due to updates of earth relief data (#498) @seisman * Unpin pylint version and fix some lint warnings (#484) @weiji14 * Separate tests of gmtinfo and grdinfo (#461) @seisman From 4785a435f3154bf55146b91ba2eedf21bb05601c Mon Sep 17 00:00:00 2001 From: Wei Ji Date: Sun, 5 Jul 2020 16:32:33 +1200 Subject: [PATCH 3/8] Format Pull Request links using sed Also updated MAINTENANCE.md to include the `sed` command, instead of using `vim`. --- MAINTENANCE.md | 4 ++-- doc/changes.rst | 34 +++++++++++++++++----------------- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index b33a68be717..a0b1a86ca2b 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -100,8 +100,8 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html 2. Edit the changes list to remove any trivial changes (updates to the README, typo fixes, CI configuration, etc). -3. Replace the PR number in the commit titles with a link to the Github PR page. In Vim, - use `` %s$#\([0-9]\+\)$`#\1 `__$g `` +3. Replace the PR number in the commit titles with a link to the Github PR page. + Use ``sed -i.bak -E 's$\(#([0-9]*)\)$(`#\1 `__)$g' changes.rst`` to make the change automatically. 4. Copy the remaining changes to `doc/changes.rst` under a new section for the intended release. diff --git a/doc/changes.rst b/doc/changes.rst index d243035b253..bc7e079676d 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -11,35 +11,35 @@ Highlights: New Features: -* Wrap grdcut (#492) @seisman -* Add show_versions() function for printing debugging information used in issue reports (#466) @seisman +* Wrap grdcut (`#492 `__) @seisman +* Add show_versions() function for printing debugging information used in issue reports (`#466 `__) @seisman Enhancements: -* Change load_earth_relief()'s default resolution to 01d (#488) @seisman -* Enhance text with extra functionality and aliases (#481) @weiji14 +* Change load_earth_relief()'s default resolution to 01d (`#488 `__) @seisman +* Enhance text with extra functionality and aliases (`#481 `__) @weiji14 Documentation: -* Add gallery example for grdview (#502) @liamtoney -* Turn all short aliases into long form (#474) @weiji14 -* Update the plotting example using the colormap generated by pygmt.makecpt (#472) @seisman -* Add instructions to view the test coverage reports locally (#468) @seisman -* Update the instructions for testing pygmt install (#459) @seisman +* Add gallery example for grdview (`#502 `__) @liamtoney +* Turn all short aliases into long form (`#474 `__) @weiji14 +* Update the plotting example using the colormap generated by pygmt.makecpt (`#472 `__) @seisman +* Add instructions to view the test coverage reports locally (`#468 `__) @seisman +* Update the instructions for testing pygmt install (`#459 `__) @seisman Bug Fixes: -* Fix a bug when passing data to GMT in Session.open_virtual_file() (#490) @seisman +* Fix a bug when passing data to GMT in Session.open_virtual_file() (`#490 `__) @seisman Maintenance: -* Temporarily expect failures for some grdcontour and grdview tests (#503) @weiji14 -* Fix several failures due to updates of earth relief data (#498) @seisman -* Unpin pylint version and fix some lint warnings (#484) @weiji14 -* Separate tests of gmtinfo and grdinfo (#461) @seisman -* Fix the test for GMT_COMPATIBILITY=6 (#454) @seisman -* Update baseline images for updates of earth relief data (#452) @seisman -* Simplify PyGMT Release process (#446) @weiji14 +* Temporarily expect failures for some grdcontour and grdview tests (`#503 `__) @weiji14 +* Fix several failures due to updates of earth relief data (`#498 `__) @seisman +* Unpin pylint version and fix some lint warnings (`#484 `__) @weiji14 +* Separate tests of gmtinfo and grdinfo (`#461 `__) @seisman +* Fix the test for GMT_COMPATIBILITY=6 (`#454 `__) @seisman +* Update baseline images for updates of earth relief data (`#452 `__) @seisman +* Simplify PyGMT Release process (`#446 `__) @weiji14 This release contains contributions from: From e87c7eec929804321e472aacd6afa963bcf85de8 Mon Sep 17 00:00:00 2001 From: Wei Ji Date: Sun, 5 Jul 2020 16:36:26 +1200 Subject: [PATCH 4/8] Add reserved Zenodo DOI badge for v0.1.2 --- doc/changes.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/changes.rst b/doc/changes.rst index bc7e079676d..e7eb2a6302e 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -4,6 +4,10 @@ Changelog Release v0.1.2 (2020/07/XX) --------------------------- +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3930577.svg + :alt: Digital Object Identifier for the Zenodo archive + :target: https://doi.org/10.5281/zenodo.3930577 + Highlights: * Patch release in preparation for the Scipy 2020 sprint session From d56050e42ef0e3ec92e99938921eb8188d8d8f41 Mon Sep 17 00:00:00 2001 From: Wei Ji Date: Sun, 5 Jul 2020 16:50:49 +1200 Subject: [PATCH 5/8] Just use Contributors as heading for list of contributors in the release Release Drafter will now automatically list contributors! --- .github/release-drafter.yml | 4 ++++ doc/changes.rst | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index af130e041fc..33aea98b173 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -24,3 +24,7 @@ template: | * $CHANGES + + ## Contributors + + $CONTRIBUTORS diff --git a/doc/changes.rst b/doc/changes.rst index e7eb2a6302e..b87c8b14ebe 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -45,7 +45,7 @@ Maintenance: * Update baseline images for updates of earth relief data (`#452 `__) @seisman * Simplify PyGMT Release process (`#446 `__) @weiji14 -This release contains contributions from: +Contributors: * Dongdong Tian `(@seisman) `__ * Wei Ji Leong `(@weiji14) `__ From 057614183243c49b1f24fca01ae6d80cefa6b9a3 Mon Sep 17 00:00:00 2001 From: Wei Ji Date: Tue, 7 Jul 2020 11:39:05 +1200 Subject: [PATCH 6/8] Remove the @$AUTHOR github username from changelog --- .github/release-drafter.yml | 2 +- doc/changes.rst | 40 ++++++++++++++++++------------------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 33aea98b173..a8f19cbcbf0 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -15,7 +15,7 @@ categories: label: 'deprecation' exclude-labels: - 'skip-changelog' -change-template: '* $TITLE (#$NUMBER) @$AUTHOR' +change-template: '* $TITLE (#$NUMBER)' template: | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524) diff --git a/doc/changes.rst b/doc/changes.rst index b87c8b14ebe..8b8bdcbbe90 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -15,41 +15,41 @@ Highlights: New Features: -* Wrap grdcut (`#492 `__) @seisman -* Add show_versions() function for printing debugging information used in issue reports (`#466 `__) @seisman +* Wrap grdcut (`#492 `__) +* Add show_versions() function for printing debugging information used in issue reports (`#466 `__) Enhancements: -* Change load_earth_relief()'s default resolution to 01d (`#488 `__) @seisman -* Enhance text with extra functionality and aliases (`#481 `__) @weiji14 +* Change load_earth_relief()'s default resolution to 01d (`#488 `__) +* Enhance text with extra functionality and aliases (`#481 `__) Documentation: -* Add gallery example for grdview (`#502 `__) @liamtoney -* Turn all short aliases into long form (`#474 `__) @weiji14 -* Update the plotting example using the colormap generated by pygmt.makecpt (`#472 `__) @seisman -* Add instructions to view the test coverage reports locally (`#468 `__) @seisman -* Update the instructions for testing pygmt install (`#459 `__) @seisman +* Add gallery example for grdview (`#502 `__) +* Turn all short aliases into long form (`#474 `__) +* Update the plotting example using the colormap generated by pygmt.makecpt (`#472 `__) +* Add instructions to view the test coverage reports locally (`#468 `__) +* Update the instructions for testing pygmt install (`#459 `__) Bug Fixes: -* Fix a bug when passing data to GMT in Session.open_virtual_file() (`#490 `__) @seisman +* Fix a bug when passing data to GMT in Session.open_virtual_file() (`#490 `__) Maintenance: -* Temporarily expect failures for some grdcontour and grdview tests (`#503 `__) @weiji14 -* Fix several failures due to updates of earth relief data (`#498 `__) @seisman -* Unpin pylint version and fix some lint warnings (`#484 `__) @weiji14 -* Separate tests of gmtinfo and grdinfo (`#461 `__) @seisman -* Fix the test for GMT_COMPATIBILITY=6 (`#454 `__) @seisman -* Update baseline images for updates of earth relief data (`#452 `__) @seisman -* Simplify PyGMT Release process (`#446 `__) @weiji14 +* Temporarily expect failures for some grdcontour and grdview tests (`#503 `__) +* Fix several failures due to updates of earth relief data (`#498 `__) +* Unpin pylint version and fix some lint warnings (`#484 `__) +* Separate tests of gmtinfo and grdinfo (`#461 `__) +* Fix the test for GMT_COMPATIBILITY=6 (`#454 `__) +* Update baseline images for updates of earth relief data (`#452 `__) +* Simplify PyGMT Release process (`#446 `__) Contributors: -* Dongdong Tian `(@seisman) `__ -* Wei Ji Leong `(@weiji14) `__ -* Liam Toney `(@liamtoney) `__ +* `Dongdong Tian `__ +* `Wei Ji Leong `__ +* `Liam Toney `__ ---- From 22cc08620c4241d7a773f3adb7e7f7cce153c587 Mon Sep 17 00:00:00 2001 From: Wei Ji Date: Tue, 7 Jul 2020 11:42:13 +1200 Subject: [PATCH 7/8] Set release date to 2020/07/07 and fix a typo Co-Authored-By: Dongdong Tian --- doc/changes.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index 8b8bdcbbe90..85c94b2a3c9 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -1,7 +1,7 @@ Changelog ========= -Release v0.1.2 (2020/07/XX) +Release v0.1.2 (2020/07/07) --------------------------- .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3930577.svg @@ -10,7 +10,7 @@ Release v0.1.2 (2020/07/XX) Highlights: -* Patch release in preparation for the Scipy 2020 sprint session +* Patch release in preparation for the SciPy 2020 sprint session * Last version to support GMT 6.0, future PyGMT versions will require GMT 6.1 or newer New Features: From 5e4e88e48d80e5856199e3d3b59335d90e8dbb1c Mon Sep 17 00:00:00 2001 From: Wei Ji Date: Tue, 7 Jul 2020 11:53:26 +1200 Subject: [PATCH 8/8] Add @moorepants as contributor to pygmt v0.1.1 for the conda-forge setup --- doc/changes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/changes.rst b/doc/changes.rst index 85c94b2a3c9..59e5d43b046 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -89,6 +89,7 @@ This release contains contributions from: * `Dongdong Tian `__ * `Wei Ji Leong `__ +* `Jason K. Moore `__ ----