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

Update instructions for checking README syntax for release #2173

Closed
Tracked by #2244
maxrjones opened this issue Oct 27, 2022 · 4 comments · Fixed by #2265
Closed
Tracked by #2244

Update instructions for checking README syntax for release #2173

maxrjones opened this issue Oct 27, 2022 · 4 comments · Fixed by #2265
Assignees
Labels
maintenance Boring but important stuff for the core devs
Milestone

Comments

@maxrjones
Copy link
Member

Description of the desired feature

The instructions from the maintenance guide for checking the README syntax prior to a release are outdated since we no longer use setup.py.

We should be able to use twine to check the long description instead, ideally as part of the CI rather than as a manual part of the release process.

Are you willing to help implement and maintain this feature? Yes

@maxrjones maxrjones added the maintenance Boring but important stuff for the core devs label Oct 27, 2022
@weiji14
Copy link
Member

weiji14 commented Oct 27, 2022

We should be able to use twine to check the long description instead, ideally as part of the CI rather than as a manual part of the release process.

Sounds good, maybe put the twine check somewhere in https://github.com/GenericMappingTools/pygmt/blob/v0.7.0/.github/workflows/publish-to-pypi.yml following what you did in xarray-contrib/xbatcher#108?

@seisman seisman added this to the 0.8.0 milestone Oct 28, 2022
@seisman
Copy link
Member

seisman commented Oct 28, 2022

As I understand it, twine check only checks if the long description will render correctly, which may not help if someone mistypes *abc* as **abc*.

Perhaps we can simply visit the TestPyPI release history page (https://test.pypi.org/project/pygmt/#history), and click to the README page of the latest dev release (e.g., https://test.pypi.org/project/pygmt/0.7.1.dev130/ now).

@seisman
Copy link
Member

seisman commented Nov 22, 2022

Just found a issue by visiting the latest dev version on the TestPyPI page (https://test.pypi.org/project/pygmt/0.7.1.dev157/).

The maintainer information are not correctly shown:

Screen Shot 2022-11-22 at 18 42 55

@maxrjones
Copy link
Member Author

Just found a issue by visiting the latest dev version on the TestPyPI page (https://test.pypi.org/project/pygmt/0.7.1.dev157/).

The maintainer information are not correctly shown

From https://packaging.python.org/en/latest/specifications/core-metadata/#maintainer:

Note that this field is intended for use when a project is being maintained by someone other than the original author: it should be omitted if it is identical to Author.

I see this in many packages, but I think we should not have separate maintainers metadata because it is identical to authors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants