Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changelog entry for v0.1.2 #504

Merged
merged 9 commits into from
Jul 7, 2020
Merged

Changelog entry for v0.1.2 #504

merged 9 commits into from
Jul 7, 2020

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Jul 5, 2020

Description of proposed changes

Patch release in preparation for the Scipy 2020 sprint session. Preview it live at https://pygmt-git-changelog-v012.gmt.now.sh/changes.html. For reference, the previous changelog is at #445.

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
  • List of Contributors (sorted by number of commits)

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 in new Pull Requests merged in for v0.1.2

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.

Patch release in preparation for the Scipy 2020 sprint session.
@seisman seisman mentioned this pull request Jul 5, 2020
10 tasks
weiji14 added 2 commits July 5, 2020 16:32
Also updated MAINTENANCE.md to include the `sed` command, instead of using `vim`.
Release Drafter will now automatically list contributors!
@weiji14 weiji14 marked this pull request as ready for review July 5, 2020 08:06
doc/changes.rst Outdated

Highlights:

* Patch release in preparation for the Scipy 2020 sprint session
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Patch release in preparation for the Scipy 2020 sprint session
* Patch release in preparation for the SciPy 2020 sprint session

doc/changes.rst Outdated

New Features:

* Wrap grdcut (`#492 <https://github.com/GenericMappingTools/pygmt/pull/492>`__) @seisman
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about removing the authors in each entry? It won't work in reST.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I'll remove it from the Release Drafter yml specification too.

doc/changes.rst Outdated
@@ -1,6 +1,58 @@
Changelog
=========

Release v0.1.2 (2020/07/XX)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remember to update the date before merging.

Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@weiji14
Copy link
Member Author

weiji14 commented Jul 6, 2020

One last thing. We should have done this in v0.1.1, but I feel like we should add @moorepants to the Contributor list for his help on setting up the conda-forge pygmt package.

@seisman
Copy link
Member

seisman commented Jul 6, 2020

Yes, of course.

@weiji14 weiji14 merged commit bedb48d into master Jul 7, 2020
@weiji14 weiji14 deleted the changelog/v0.1.2 branch July 7, 2020 00:25
@weiji14 weiji14 added the skip-changelog Skip adding Pull Request to changelog label Jul 7, 2020
@weiji14 weiji14 mentioned this pull request Sep 11, 2020
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants