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.4.0 #1341

Merged
merged 28 commits into from
Jun 20, 2021
Merged

Changelog entry for v0.4.0 #1341

merged 28 commits into from
Jun 20, 2021

Conversation

maxrjones
Copy link
Member

@maxrjones maxrjones commented Jun 19, 2021

Description of proposed changes

This PR is a draft changelog entry for v0.4.0.

Preview: https://pygmt-git-changelog-release-gmt.vercel.app/changes.html#changelog

Previous release at #1047

Changelog made by following the instructions at https://github.com/GenericMappingTools/pygmt/blob/master/doc/maintenance.md#updating-the-changelog

To do:

Relates to #1333

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.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@maxrjones maxrjones marked this pull request as draft June 19, 2021 20:35
@maxrjones
Copy link
Member Author

For updating the citation information, the AUTHORSHIP.md file says that "The order of authors will be defined by the number of commits to the repository (git shortlog -sne). The order can also be changed on a case-by-case basis." How do I know whether any of the current order reflects a case-by-case basis or whether I should update based on git shortlog -sne?

@weiji14
Copy link
Member

weiji14 commented Jun 19, 2021

How do I know whether any of the current order reflects a case-by-case basis or whether I should update based on git shortlog -sne?

See previous discussion at #1047 (comment). Will leave it up to you to take a first stab at the order :) Just to clarify, that line refers to the Zenodo citation order. The release note authors order should go strictly by git shortlog (and remove the bots).

@maxrjones
Copy link
Member Author

How do I know whether any of the current order reflects a case-by-case basis or whether I should update based on git shortlog -sne?

See previous discussion at #1047 (comment). Will leave it up to you to take a first stab at the order :) Just to clarify, that line refers to the Zenodo citation order. The release note authors order should go strictly by git shortlog (and remove the bots).

OK, I guess I wasn't paying good attention for that release :) Thanks for the note.

@maxrjones
Copy link
Member Author

The index.html result from the python setup.py --long-description | rst2html.py --no-raw > index.html step does not render the badges correctly. Does this need to be corrected?

image

@maxrjones
Copy link
Member Author

I did the contributors section based on the git log, but I would like to add the three others who were involved in #1070 and #1193 since this method does not recognize team programming. I will do this early tomorrow if there are no objections.

@seisman
Copy link
Member

seisman commented Jun 20, 2021

The index.html result from the python setup.py --long-description | rst2html.py --no-raw > index.html step does not render the badges correctly. Does this need to be corrected?

image

I don't think it's an issue. The badges are working on the pypi site (https://pypi.org/project/pygmt/) and we don't make changes to badges since v0.3.1.

@maxrjones maxrjones changed the title WIP: Changelog entry for v0.4.0 Changelog entry for v0.4.0 Jun 20, 2021
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
@maxrjones maxrjones marked this pull request as ready for review June 20, 2021 16:04
Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

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

From my side everything looks fine. All open points are considered. Great work!

@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed final review call This PR requires final review and approval from a second reviewer labels Jun 20, 2021
Copy link
Member

@core-man core-man left a comment

Choose a reason for hiding this comment

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

I did not check the authors, but all the other looks great.

@maxrjones maxrjones added final review call This PR requires final review and approval from a second reviewer and removed final review call This PR requires final review and approval from a second reviewer labels Jun 20, 2021
@maxrjones
Copy link
Member Author

Should I wait for Wei Ji to approve as well or is OK to move forward with the comments addressed and the three approvals?

@core-man
Copy link
Member

Should I wait for Wei Ji to approve as well or is OK to move forward with the comments addressed and the three approvals?

Perhaps it would better to wait for his approval too, since it does not matter to release v0.4 a few hours earlier or later.

Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Just one suggestion, otherwise all good!

doc/changes.md Outdated Show resolved Hide resolved
@maxrjones maxrjones merged commit b2808cf into master Jun 20, 2021
@maxrjones maxrjones deleted the changelog-release branch June 20, 2021 22:04
@core-man core-man mentioned this pull request Aug 5, 2021
12 tasks
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
* Add changelog entry to changes.md
* Update release highlights
* Reorganize contributor list
* Update citation
* Update version_switch.js
* Update documentation link

Co-authored-by: Wei Ji <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Yao Jiayuan <[email protected]>
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.

None yet

5 participants