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.1 #445

Merged
merged 4 commits into from
May 22, 2020
Merged

Changelog entry for v0.1.1 #445

merged 4 commits into from
May 22, 2020

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented May 21, 2020

Description of proposed changes

A bugfix release to finally support Windows! Preview it live at https://pygmt-git-changelog-v011.gmt.now.sh/changes.html. For reference, the previous changelog is at #420.

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
  • 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.1

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.

A bugfix release to finally support Windows!
@weiji14 weiji14 added this to the 0.1.x milestone May 21, 2020
@weiji14 weiji14 mentioned this pull request May 21, 2020
9 tasks
doc/changes.rst Outdated Show resolved Hide resolved
doc/changes.rst Outdated Show resolved Hide resolved
doc/changes.rst Show resolved Hide resolved
Fixed typo, add horizontal rule to separate between different versions, and removed minor Pull Request from change list.

Co-authored-by: Dongdong Tian <[email protected]>
@seisman
Copy link
Member

seisman commented May 22, 2020

The vim command above also replaces #xxx (again) in old releases. Better to use the sed command below:

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

@weiji14
Copy link
Member Author

weiji14 commented May 22, 2020

The vim command above also replaces #xxx (again) in old releases. Better to use the sed command below:

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

Good one, much prefer sed to be honest. This should be pretty much done. Do you want to release today or wait for tomorrow?

@seisman
Copy link
Member

seisman commented May 22, 2020

Do you want to release today or wait for tomorrow?

No need to wait another day. Let's do it today.

@weiji14 weiji14 merged commit 809a888 into master May 22, 2020
@weiji14 weiji14 deleted the changelog/v0.1.1 branch May 22, 2020 03:04
@weiji14 weiji14 mentioned this pull request Jul 5, 2020
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants