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.8.0 #2272

Merged
merged 75 commits into from
Dec 29, 2022
Merged

Changelog entry for v0.8.0 #2272

merged 75 commits into from
Dec 29, 2022

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Dec 25, 2022

Description of proposed changes

This PR adds the changelog entry for v0.8.0.

Preview at https://pygmt-dev--2272.org.readthedocs.build/en/2272/changes.html

Related to issue #2244

Previous release v0.7.0 at #1981

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

TODO

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

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

@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 25, 2022
65 tasks
@yvonnefroehlich
Copy link
Member Author

yvonnefroehlich commented Dec 25, 2022

@GenericMappingTools/pygmt-maintainers I have started to update the information regarding the release:

  • For the BibTex in the README.rst we state vx.y.z for the version, but in the CITATION.cff only x.y.z is given.
  • Do we have to update Paul Wessels affiliation? When yes to what?
  • I am unsure about updating the order of authors. It seems that the first criterion is the number of commits (merged pull requests) given at the Contributors page. But there are some differences between the number-of-commits based order and the final order. Maybe / Probably from including other contributions, like e.g., code-review, conference contributions / workshops / sprints, and writing grants / proposals (see AUTHORSHIP.md).

@yvonnefroehlich yvonnefroehlich added this to the 0.8.0 milestone Dec 25, 2022
@yvonnefroehlich yvonnefroehlich added enhancement Improving an existing feature skip-changelog Skip adding Pull Request to changelog labels Dec 25, 2022
@seisman
Copy link
Member

seisman commented Dec 26, 2022

  • For the BibTex in the README.rst we state vx.y.z for the version, but in the CITATION.cff only x.y.z is given.

Nice catch. The example file on the CFF homepage (https://citation-file-format.github.io/) also uses x.y.z only (also see the CFF specifications at https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#version). So I think this is the way to go.

  • Do we have to update Paul Wessels affiliation? When yes to what?

Paul is still at the University of Hawaii, no?

@yvonnefroehlich
Copy link
Member Author

  • For the BibTex in the README.rst we state vx.y.z for the version, but in the CITATION.cff only x.y.z is given.

Nice catch. The example file on the CFF homepage (https://citation-file-format.github.io/) also uses x.y.z only (also see the CFF specifications at https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#version). So I think this is the way to go.

Thanks for this background information. Meaning I should remove the v from the BibTex entry?

  • Do we have to update Paul Wessels affiliation? When yes to what?

Paul is still at the University of Hawaii, no?

I was wondering, whether his change to Norway (please see this comment GenericMappingTools/website#141 (comment)) influences his affiliation.

@yvonnefroehlich
Copy link
Member Author

I am not sure about the compatibility versions for the v0.8.0 release and the dev version.

I copyed the release draft to the change.md. I feel the lists, especially the section "Maintenance", are quite long and we have to discuss which PRs we want to mention.

@seisman
Copy link
Member

seisman commented Dec 26, 2022

  • Do we have to update Paul Wessels affiliation? When yes to what?

Paul is still at the University of Hawaii, no?

I was wondering, whether his change to Norway (please see this comment GenericMappingTools/website#141 (comment)) influences his affiliation.

Ping @PaulWessel to check if his affiliation has changed.

@PaulWessel
Copy link
Member

No change.

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
@seisman
Copy link
Member

seisman commented Dec 26, 2022

  • I am unsure about updating the order of authors. It seems that the first criterion is the number of commits (merged pull requests) given at the Contributors page. But there are some differences between the number-of-commits based order and the final order. Maybe / Probably from including other contributions, like e.g., code-review, conference contributions / workshops / sprints, and writing grants / proposals (see AUTHORSHIP.md).

For the order of authors of this release, I think you can move your name after Liam and keep the order of other names untouched.

I am not sure about the compatibility versions for the v0.8.0 release and the dev version.

We follow the NEP 29 policy, so for this release, we support Python>=3.8 and NumPy>=1.20 (The minimum supported versions are also shown in https://github.com/GenericMappingTools/pygmt/blob/main/pyproject.toml)

yvonnefroehlich and others added 2 commits December 26, 2022 19:24
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
doc/changes.md Outdated Show resolved Hide resolved
@yvonnefroehlich
Copy link
Member Author

PR #2172 adds support for Python 3.11. Currently the badge for Python (please see https://github.com/GenericMappingTools/pygmt#pygmt) shows the version python 3.8 | 3.9 | 3.10. How is this updated?

@seisman
Copy link
Member

seisman commented Dec 29, 2022

PR #2172 adds support for Python 3.11. Currently the badge for Python (please see https://github.com/GenericMappingTools/pygmt#pygmt) shows the version python 3.8 | 3.9 | 3.10. How is this updated?

The badge reflects supported Python versions of the latest release on PyPI. So it will show Python 3.11 after we make the release.

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.

Looks good to me except two minor changes.

doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Dec 29, 2022
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.

Wonderful, thanks again @yvonnefroehlich! Just a few minor changes.

After this is merged, do you want to make the release following https://github.com/GenericMappingTools/pygmt/blob/v0.7.0/doc/maintenance.md#pushing-to-pypi-and-updating-the-documentation?

CITATION.cff Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
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.

Looks good! Thanks all for the great work!

Copy link
Contributor

@willschlitzer willschlitzer left a comment

Choose a reason for hiding this comment

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

Looks good after @weiji14's comments!

@weiji14
Copy link
Member

weiji14 commented Dec 29, 2022

@yvonnefroehlich, just checking if you have permission to merge? If not, I can merge this PR.

Edit: Just realized that the main branch is protected and might only allow people with maintain or admin permissions to push to it. So I'll merge this in.

@weiji14 weiji14 merged commit 1bf0c2b into main Dec 29, 2022
@weiji14 weiji14 deleted the pygmt-changelog-v0.8.0 branch December 29, 2022 21:56
@weiji14 weiji14 removed the final review call This PR requires final review and approval from a second reviewer label Dec 29, 2022
@maxrjones maxrjones mentioned this pull request Mar 30, 2023
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improving an existing feature skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants