Skip to content

Commit

Permalink
Changelog entry for v0.1.2 (#504)
Browse files Browse the repository at this point in the history
Patch release in preparation for the Scipy 2020 sprint session.

* Format Pull Request links using sed
Also updated MAINTENANCE.md to include the `sed` command, instead of using `vim`.

* Just use Contributors as heading for list of contributors in the release
Release Drafter will now automatically list contributors!

* Remove the @$AUTHOR github username from changelog

* Set release date to 2020/07/07 and fix a typo

Co-Authored-By: Dongdong Tian <seisman.info@gmail.com>
  • Loading branch information
weiji14 and seisman authored Jul 7, 2020
1 parent fccb45c commit bedb48d
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 3 deletions.
6 changes: 5 additions & 1 deletion .github/release-drafter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -24,3 +24,7 @@ template: |
*
$CHANGES
## Contributors
$CONTRIBUTORS
4 changes: 2 additions & 2 deletions MAINTENANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/GenericMappingTools/pygmt/pull/\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 <https://github.com/GenericMappingTools/pygmt/pull/\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.
Expand Down
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,5 +171,7 @@ Documentation for other versions
* `Development <https://www.pygmt.org/dev>`__ (reflects the *master* branch on
Github)
* `Latest release <https://www.pygmt.org/latest>`__
* `v0.1.2 <https://www.pygmt.org/v0.1.2>`__
* `v0.1.1 <https://www.pygmt.org/v0.1.1>`__
* `v0.1.0 <https://www.pygmt.org/v0.1.0>`__
* `v0.0.1a0 <https://www.pygmt.org/0.0.1a0>`__
53 changes: 53 additions & 0 deletions doc/changes.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,58 @@
Changelog
=========

Release v0.1.2 (2020/07/07)
---------------------------

.. 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
* Last version to support GMT 6.0, future PyGMT versions will require GMT 6.1 or newer

New Features:

* Wrap grdcut (`#492 <https://github.com/GenericMappingTools/pygmt/pull/492>`__)
* Add show_versions() function for printing debugging information used in issue reports (`#466 <https://github.com/GenericMappingTools/pygmt/pull/466>`__)

Enhancements:

* Change load_earth_relief()'s default resolution to 01d (`#488 <https://github.com/GenericMappingTools/pygmt/pull/488>`__)
* Enhance text with extra functionality and aliases (`#481 <https://github.com/GenericMappingTools/pygmt/pull/481>`__)

Documentation:

* Add gallery example for grdview (`#502 <https://github.com/GenericMappingTools/pygmt/pull/502>`__)
* Turn all short aliases into long form (`#474 <https://github.com/GenericMappingTools/pygmt/pull/474>`__)
* Update the plotting example using the colormap generated by pygmt.makecpt (`#472 <https://github.com/GenericMappingTools/pygmt/pull/472>`__)
* Add instructions to view the test coverage reports locally (`#468 <https://github.com/GenericMappingTools/pygmt/pull/468>`__)
* Update the instructions for testing pygmt install (`#459 <https://github.com/GenericMappingTools/pygmt/pull/459>`__)

Bug Fixes:

* Fix a bug when passing data to GMT in Session.open_virtual_file() (`#490 <https://github.com/GenericMappingTools/pygmt/pull/490>`__)

Maintenance:

* Temporarily expect failures for some grdcontour and grdview tests (`#503 <https://github.com/GenericMappingTools/pygmt/pull/503>`__)
* Fix several failures due to updates of earth relief data (`#498 <https://github.com/GenericMappingTools/pygmt/pull/498>`__)
* Unpin pylint version and fix some lint warnings (`#484 <https://github.com/GenericMappingTools/pygmt/pull/484>`__)
* Separate tests of gmtinfo and grdinfo (`#461 <https://github.com/GenericMappingTools/pygmt/pull/461>`__)
* Fix the test for GMT_COMPATIBILITY=6 (`#454 <https://github.com/GenericMappingTools/pygmt/pull/454>`__)
* Update baseline images for updates of earth relief data (`#452 <https://github.com/GenericMappingTools/pygmt/pull/452>`__)
* Simplify PyGMT Release process (`#446 <https://github.com/GenericMappingTools/pygmt/pull/446>`__)

Contributors:

* `Dongdong Tian <https://github.com/seisman>`__
* `Wei Ji Leong <https://github.com/weiji14>`__
* `Liam Toney <https://github.com/liamtoney>`__

----

Release v0.1.1 (2020/05/22)
---------------------------

Expand Down Expand Up @@ -37,6 +89,7 @@ This release contains contributions from:

* `Dongdong Tian <https://github.com/seisman>`__
* `Wei Ji Leong <https://github.com/weiji14>`__
* `Jason K. Moore <https://github.com/moorepants>`__

----

Expand Down

0 comments on commit bedb48d

Please sign in to comment.