Ensure proper non-dev version string when publishing to PyPI by weiji14 · Pull Request #900 · GenericMappingTools/pygmt

weiji14 · 2021-02-15T12:11:41Z

Description of proposed changes

Ensures that the PyPI release Github Action workflow has a proper version string like v0.3.0 instead of v0.3.1.dev0. Also edit the Publish-to-PyPI workflow to only run on GenericMappingTools/pygmt and rename secrets from *_PYPI_PASSWORD to *_PYPI_API_TOKEN

Publish Publish Github Action Documentation is at https://github.com/pypa/gh-action-pypi-publish/tree/v1.4.2

Addresses #845 (comment), also fixes #901.

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

.github/workflows/publish-to-pypi.yml

seisman · 2021-02-16T00:28:54Z

Please see #901, and let me know if you want to fix it in this PR.

Disables the Publish to PyPI Github Action on forks of pygmt.

weiji14 · 2021-02-16T10:34:28Z

Please see #901, and let me know if you want to fix it in this PR.

Ok, I think the issues in #901 have been addressed, but please double check. Note: Will need to rename TEST_PYPI_PASSWORD -> TEST_PYPI_API_TOKEN and PYPI_PASSWORD -> PYPI_API_TOKEN before merging this PR.

seisman · 2021-02-16T15:25:23Z

.github/workflows/publish-to-pypi.yml

-    - name: Fix up version string
+    # This step is only necessary for testing purposes and for TestPyPI
+    - name: Fix up version string for TestPyPI
+      if: ${{ !startsWith(github.ref, 'refs/tags') }}


If I understand it correctly, when we make a release/tag, this sed command won't run. So, we are pushing the same versions (e.g., v0.3.1) to both PyPI and TestPyPI, right?

Yes, correct. But I think pushing v0.3.1 to both PyPI and TestPyPI is fine right?

Yes, it looks good.

seisman

Things to do before merging:

Rename the secrets in https://github.com/GenericMappingTools/pygmt/settings/secrets/actions
Update the PR title

seisman · 2021-02-16T20:24:58Z

.github/workflows/publish-to-pypi.yml

-    - name: Fix up version string
+    # This step is only necessary for testing purposes and for TestPyPI
+    - name: Fix up version string for TestPyPI
+      if: ${{ !startsWith(github.ref, 'refs/tags') }}


Yes, it looks good.

weiji14 · 2021-02-16T20:40:11Z

Things to do before merging:

1. Rename the secrets in https://github.com/GenericMappingTools/pygmt/settings/secrets/actions

Ok, generated new tokens and created new secrets for PyPI and TestPyPI. Also deleted the old TEST_PYPI_PASSWORD and PYPI_PASSWORD secrets at https://github.com/GenericMappingTools/pygmt/settings/secrets/actions.

2. Update the PR title

See if it looks ok, having trouble describing this PR 😅

seisman

Looks good.

weiji14 · 2021-02-16T20:43:49Z

I might trigger a quick test (to TestPyPI) just to make sure things work. Edit: Yep, it works, see https://github.com/GenericMappingTools/pygmt/pull/900/checks?check_run_id=1913789675.

This reverts commit 0935a64.

…MappingTools#900) * Don't edit setuptools-scm for PyPI releases * Move up comment on 'Fix up version string for TestPyPI' step * Only run the Publish to PyPI workflow on GenericMappingTools/pygmt * Rename secrets from PYPI_PASSWORD to PYPI_API_TOKEN

Don't edit setuptools-scm for PyPI releases

3138a96

weiji14 added the maintenance Boring but important stuff for the core devs label Feb 15, 2021

seisman added this to the 0.4.0 milestone Feb 15, 2021

seisman reviewed Feb 15, 2021

View reviewed changes

.github/workflows/publish-to-pypi.yml Outdated Show resolved Hide resolved

seisman mentioned this pull request Feb 15, 2021

Issues of the "Publish to PyPI" workflow #901

Closed

Move up comment on 'Fix up version string for TestPyPI' step

82290d6

vercel bot temporarily deployed to Preview February 16, 2021 10:04 Inactive

weiji14 added 2 commits February 16, 2021 23:06

Only run the Publish to PyPI workflow on GenericMappingTools/pygmt

52814b7

Disables the Publish to PyPI Github Action on forks of pygmt.

Rename secrets from PYPI_PASSWORD to PYPI_API_TOKEN

0bee4bb

weiji14 force-pushed the publish-to-pypi-correctly branch from a818172 to 0bee4bb Compare February 16, 2021 10:06

vercel bot temporarily deployed to Preview February 16, 2021 10:12 Inactive

Fix a typo in Publish to PyPI workflow file

f9dc871

vercel bot temporarily deployed to Preview February 16, 2021 10:25 Inactive

Try fix Github Actions yaml error

4573a1e

vercel bot temporarily deployed to Preview February 16, 2021 10:32 Inactive

seisman reviewed Feb 16, 2021

View reviewed changes

seisman modified the milestones: 0.4.0, 0.3.1 Feb 16, 2021

seisman approved these changes Feb 16, 2021

View reviewed changes

weiji14 changed the title ~~Don't edit setuptools-scm for PyPI releases~~ Ensure proper non-dev version string when publishing to PyPI Feb 16, 2021

seisman approved these changes Feb 16, 2021

View reviewed changes

weiji14 added 2 commits February 17, 2021 09:45

Merge branch 'master' into publish-to-pypi-correctly

2e793ec

Trigger quick test publishing to TestPyPI

0935a64

vercel bot temporarily deployed to Preview February 16, 2021 20:46 Inactive

[skip ci] Revert "Trigger quick test publishing to TestPyPI"

3bbd733

This reverts commit 0935a64.

weiji14 merged commit 4ef9038 into master Feb 16, 2021

weiji14 deleted the publish-to-pypi-correctly branch February 16, 2021 20:50

vercel bot temporarily deployed to Preview February 16, 2021 20:53 Inactive

weiji14 mentioned this pull request Mar 23, 2023

Publish to TestPyPI and PyPI via OpenID Connect token #2453

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure proper non-dev version string when publishing to PyPI#900

Ensure proper non-dev version string when publishing to PyPI#900
weiji14 merged 9 commits intomasterfrom
publish-to-pypi-correctly

weiji14 commented Feb 15, 2021 •

edited

Loading

Uh oh!

Uh oh!

seisman commented Feb 16, 2021

Uh oh!

weiji14 commented Feb 16, 2021

Uh oh!

seisman Feb 16, 2021

Uh oh!

weiji14 Feb 16, 2021

Uh oh!

seisman Feb 16, 2021

Uh oh!

seisman left a comment

Uh oh!

seisman Feb 16, 2021

Uh oh!

weiji14 commented Feb 16, 2021

Uh oh!

seisman left a comment

Uh oh!

weiji14 commented Feb 16, 2021 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

weiji14 commented Feb 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

seisman commented Feb 16, 2021

Uh oh!

weiji14 commented Feb 16, 2021

Uh oh!

seisman Feb 16, 2021

Choose a reason for hiding this comment

Uh oh!

weiji14 Feb 16, 2021

Choose a reason for hiding this comment

Uh oh!

seisman Feb 16, 2021

Choose a reason for hiding this comment

Uh oh!

seisman left a comment

Choose a reason for hiding this comment

Uh oh!

seisman Feb 16, 2021

Choose a reason for hiding this comment

Uh oh!

weiji14 commented Feb 16, 2021

Uh oh!

seisman left a comment

Choose a reason for hiding this comment

Uh oh!

weiji14 commented Feb 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

weiji14 commented Feb 15, 2021 •

edited

Loading

weiji14 commented Feb 16, 2021 •

edited

Loading