Changelog entry for v0.1.0 #420

weiji14 · 2020-04-17T08:27:34Z

Description of proposed changes

Starting a changelog for PyGMT v0.1.0! Changelog style inspired by fatiando/verde#248. Preview it live at https://pygmt-git-changelog-v010.gmt.now.sh/changes.html. It's quite long (since it's a big release), but please do go over this and let me know if I should add/change anything.

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:

Highlights
New features
Enhancements
Documentation
Bug fixes
Maintenance
Deprecations
List of Contributors (sorted by number of commits)

Excluded minor pull requests and those that were superseded by later ones. It's a bit subjective on my part, so let me know if I should add any of the ignored ones listed below back (or throw some entries into the ignored list):

* Add Liam Toney to AUTHORS.md (#415)
* Fix a typo in README.rst (#389)
* Update copyright year to 2020 (#387)
* Minor docs improvements (#386)
* Fix legend typos (#371)
* Fix small typo in disclaimer (#360)
* Quickfix plot docstring to have label (l) (#357)
* Upgrade the minimum required gmt version to 6.0.0rc5 (#351)
* Quickfix min/max elevation for new SRTM15+V2 earth relief grids (#350)
* Fix the wrong example in contributing guide (#334)
* Upgrade gmt from 6.0.0rc1 to 6.0.0rc4 (#327)
* Add Wei Ji to AUTHORS.md (#326)
* Pin sphinx<=1.8.5 to avoid style errors (#306)
* Fix the link of GMT building instructions (#304)
* Fix typos in comments and docstrings (#302)
* Use pandas.read_csv to load tutorial data (#301)
* Use sphinx-gallery 0.3.1 instead of master (#298)
* Upgrade the CI scripts to 1.1.1 (#299)
* Pin version of CI scripts to 1.0.0 (#296)
* Small format fix in the Albers projection example (#295)
* Update travis to latest GMT build script (#287)
* Let get_clib_path find the path to libgmt on Windows (#285)
* Revert "Support Windows" since it's not reviewed
* Support Windows
* Update install instructions for using GMT master (#279)
* Update copyright year in the license (#282)
* Fix copy/paste errors in CONTRIBUTING.md (#283)
* Fix more instances of gmt-python to pygmt (#277)
* Remove unused documentation files (#272)
* Fix more gmt and GMT/Python to PyGMT (#266)
* Update documentation link on the README

TODO:

Update changelog instructions on MAINTENANCE.md
Add section on other documentation versions to README.rst.
Use vim (!!!) to run %s$#$[0-9]\+$$`#\1 <https://github.com/GenericMappingTools/pygmt/pull/\1>`__$g on changes.rst. Took me a few minutes to get this right, trick is to use :wq to write (save changes) and quit.
Add Zenodo DOI link once it's reserved.
Add in new Pull Requests merged in for v0.1.0

Fixes #

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.

Changelog style inspired by https://github.com/fatiando/verde. Including highlights, new features, enhancements, documentation, bug fixes, maintenance, deprecations, and list of contributors. Excluded minor pull requests and those that were superseded by later ones. Also update changelog instructions on MAINTENANCE.md and add section on other documentation versions to README.rst.

For historical purposes, to see how far we've come!

doc/changes.rst

Co-Authored-By: Leonardo Uieda <[email protected]>

So that people can navigate to see the pull request details on Github.

MAINTENANCE.md

doc/changes.rst

weiji14 · 2020-04-24T22:57:29Z

README.rst

+* `Development <https://www.pygmt.org/dev>`__ (reflects the *master* branch on
+  Github)
+* `Latest release <https://www.pygmt.org/latest>`__


Just a reminder. We might want to switch the HTTP redirect to latest instead of dev once v0.1.0 is released.

Using a specific 'Version DOI' in the changelog, and a 'Concept DOI' in the main README page.

weiji14 · 2020-04-30T22:59:08Z

Unsure why the Zenodo DOI badge looks so huge...

Edit: Just a CSS styling issue. Fixed.

Prevents some images in the documentation (like the Zenodo DOI badge) from blowing out of proportion in size.

doc/changes.rst

weiji14 · 2020-05-01T22:42:58Z

README.rst

+.. image:: https://zenodo.org/badge/123456789.svg
+    :alt: Digital Object Identifier for the Zenodo archive
+    :target: https://zenodo.org/badge/latestdoi/123456789


Suggested change

.. image:: https://zenodo.org/badge/123456789.svg

:alt: Digital Object Identifier for the Zenodo archive

:target: https://zenodo.org/badge/latestdoi/123456789

.. image:: https://zenodo.org/badge/123456789.svg

:alt: Digital Object Identifier for the Zenodo archive

:target: https://zenodo.org/badge/latestdoi/123456789

TODO insert correct Concept DOI here.

Ok, I think I've managed to reserve a DOI on Zenodo. Seems like we'll need to make a release and then upload the repository zip/tarball before it becomes active though.

As far as I know, zenodo provides two types of DOI. Each release has its own doi, and the whole project has a permanent doi which is always resolved to the lastest release.

For example, https://doi.org/10.5281/zenodo.1068342 is the permanent doi for one of my project, and https://doi.org/10.5281/zenodo.3695076 is the doi for the v0.6.6 release.

Perhaps we should use the permanent doi in the README.rst and the release-specific doi in the changelog.

Yes, but right now it's in a draft state and it's only showing me one DOI... ~~I could upload a dummy zipfile and see if that gives me two DOIs?~~ Edit: Nope, tried it and doesn't work. Might just need to change the DOI on the README to the permanent one after releasing v0.1.0.

This is currently what I've filled in on Zenodo. I've listed everyone in our AUTHORS.md file, and Paul on the author list, and also added the NSF funding information.

Using reserved DOI from Zenodo, and update release date.

Made a release candidate on Zenodo, so that there's now a permanent DOI now that resolves to the latest PyGMT version. Also updated DOI for v0.1.0.

Because the image/url wasn't correct...

weiji14 · 2020-05-03T00:05:12Z

Ok, there's now a 'permanent' PyGMT DOI at after I made a Zenodo-only 'RC' release at . Any remaining issues before I merge this?

seisman · 2020-05-03T02:10:31Z

Shall we wait for GMT 6.1.0 before merging it and releasing PyGMT 0.1.0?

weiji14 · 2020-05-03T03:31:58Z

When's GMT 6.1.0 going to be released? Probably doesn't matter so much since pygmt just wraps around gmt>=6.0.0.

seisman · 2020-05-03T03:37:14Z

GMT 6.1.0 might be released in the next one or two weeks.

weiji14 · 2020-05-03T03:44:28Z

I kinda want to sort out the pygmt conda package soon for #414. Also we haven't got tests running on GMT 6.1.0, so might be best to put that off until PyGMT v0.2.0?

seisman · 2020-05-03T03:55:01Z

I'm OK with that.

leouieda · 2020-05-04T09:35:07Z

Thanks for handling this @weiji14 and @seisman!

weiji14 mentioned this pull request Apr 17, 2020

Release PyGMT 0.1.0 #418

Closed

10 tasks

weiji14 added this to the 0.1.0 milestone Apr 17, 2020

weiji14 added 3 commits April 22, 2020 08:47

Add link to alpha version documentation

7313a1b

For historical purposes, to see how far we've come!

Merge branch 'master' into changelog/v0.1.0

fb47138

Add blockmedian changelog entry

55fe600

vercel bot temporarily deployed to Preview April 21, 2020 20:48 Inactive

leouieda reviewed Apr 24, 2020

View reviewed changes

doc/changes.rst Show resolved Hide resolved

leouieda reviewed Apr 24, 2020

View reviewed changes

doc/changes.rst Show resolved Hide resolved

weiji14 added 2 commits April 25, 2020 10:15

Merge branch 'master' into changelog/v0.1.0

306d69d

Add changelog entry for updated installation documentation

f226bc3

vercel bot temporarily deployed to Preview April 24, 2020 22:23 Inactive

Indicate that this is PyGMT's first official release

e3c02b2

Co-Authored-By: Leonardo Uieda <[email protected]>

vercel bot temporarily deployed to Preview April 24, 2020 22:29 Inactive

Use vim to replace PR number with link to PR page

c611995

So that people can navigate to see the pull request details on Github.

vercel bot temporarily deployed to Preview April 24, 2020 22:38 Inactive

weiji14 commented Apr 24, 2020

View reviewed changes

Link contributor names to their Github page

21326b0

vercel bot temporarily deployed to Preview April 24, 2020 23:12 Inactive

weiji14 marked this pull request as ready for review April 28, 2020 19:44

Set v0.1.0 release date to 30 April 2020

cc979fa

vercel bot temporarily deployed to Preview April 29, 2020 20:36 Inactive

weiji14 requested a review from seisman April 29, 2020 21:03

Add placeholder Zenodo DOI badge

8b707e8

Using a specific 'Version DOI' in the changelog, and a 'Concept DOI' in the main README page.

vercel bot temporarily deployed to Preview April 30, 2020 22:40 Inactive

Set max image width dynamically to 80%

779aae8

Prevents some images in the documentation (like the Zenodo DOI badge) from blowing out of proportion in size.

vercel bot temporarily deployed to Preview April 30, 2020 23:28 Inactive

weiji14 mentioned this pull request May 1, 2020

fail to install gmt 6.0.0 in windows 64bit #422

Closed

weiji14 commented May 1, 2020

View reviewed changes

Update Zenodo DOI and set release date to 2 May 2020

d3f84c6

Using reserved DOI from Zenodo, and update release date.

vercel bot temporarily deployed to Preview May 2, 2020 02:52 Inactive

Set permanent DOI on main README, and update versioned DOI

244985c

Made a release candidate on Zenodo, so that there's now a permanent DOI now that resolves to the latest PyGMT version. Also updated DOI for v0.1.0.

vercel bot temporarily deployed to Preview May 2, 2020 23:50 Inactive

Fix Zenodo permanent DOI badge

245f360

Because the image/url wasn't correct...

vercel bot temporarily deployed to Preview May 2, 2020 23:56 Inactive

vercel bot temporarily deployed to Preview May 2, 2020 23:59 Inactive

Set v0.1.0 release date to 03 May 2020

317c59f

vercel bot temporarily deployed to Preview May 3, 2020 04:33 Inactive

weiji14 merged commit 74501e0 into master May 3, 2020

weiji14 deleted the changelog/v0.1.0 branch May 3, 2020 04:50

weiji14 mentioned this pull request May 21, 2020

Changelog entry for v0.1.1 #445

Merged

8 tasks

seisman mentioned this pull request Mar 12, 2021

The gallery thumbnails are too small #1038

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changelog entry for v0.1.0 #420

Changelog entry for v0.1.0 #420

weiji14 commented Apr 17, 2020 •

edited

Loading

weiji14 Apr 24, 2020

weiji14 commented Apr 30, 2020 •

edited

Loading

weiji14 May 1, 2020

weiji14 May 2, 2020

seisman May 2, 2020

weiji14 May 2, 2020 •

edited

Loading

weiji14 May 2, 2020

weiji14 commented May 3, 2020

seisman commented May 3, 2020

weiji14 commented May 3, 2020

seisman commented May 3, 2020

weiji14 commented May 3, 2020

seisman commented May 3, 2020

leouieda commented May 4, 2020

Changelog entry for v0.1.0 #420

Changelog entry for v0.1.0 #420

Conversation

weiji14 commented Apr 17, 2020 • edited Loading

weiji14 Apr 24, 2020

Choose a reason for hiding this comment

weiji14 commented Apr 30, 2020 • edited Loading

weiji14 May 1, 2020

Choose a reason for hiding this comment

weiji14 May 2, 2020

Choose a reason for hiding this comment

seisman May 2, 2020

Choose a reason for hiding this comment

weiji14 May 2, 2020 • edited Loading

Choose a reason for hiding this comment

weiji14 May 2, 2020

Choose a reason for hiding this comment

weiji14 commented May 3, 2020

seisman commented May 3, 2020

weiji14 commented May 3, 2020

seisman commented May 3, 2020

weiji14 commented May 3, 2020

seisman commented May 3, 2020

leouieda commented May 4, 2020

weiji14 commented Apr 17, 2020 •

edited

Loading

weiji14 commented Apr 30, 2020 •

edited

Loading

weiji14 May 2, 2020 •

edited

Loading