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

Migrate PyPI release to GitHub Actions #679

Merged
merged 12 commits into from
Nov 6, 2020
Merged

Migrate PyPI release to GitHub Actions #679

merged 12 commits into from
Nov 6, 2020

Conversation

seisman
Copy link
Member

@seisman seisman commented Nov 5, 2020

Description of proposed changes

This PR migrate the PyPI release job from Travis CI to GitHub Actions.

References:

Address #566

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.

Notes

  • You can write /format in the first line of a comment to lint the code automatically

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.

I made a suggestion following @leouieda's PR at fatiando/pooch#196. However, I'm not sure if I like this workaround, since we will have to switch from versioneer to setuptools_scm (#671) sooner or later.

.github/workflows/publish-to-pypi.yml Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@seisman
Copy link
Member Author

seisman commented Nov 5, 2020

See the "fake" release in the test pypi repository: https://test.pypi.org/project/pygmt/0.2.0.post0.dev52/#history

.github/workflows/publish-to-pypi.yml Outdated Show resolved Hide resolved
.github/workflows/publish-to-pypi.yml Outdated Show resolved Hide resolved
.github/workflows/publish-to-pypi.yml Show resolved Hide resolved
@seisman seisman requested a review from weiji14 November 6, 2020 01:31
@seisman seisman added the maintenance Boring but important stuff for the core devs label Nov 6, 2020
@seisman seisman added this to the 0.2.1 milestone Nov 6, 2020
@seisman seisman marked this pull request as ready for review November 6, 2020 01:31
@leouieda
Copy link
Member

leouieda commented Nov 6, 2020

I would actually recommend looking at the workflows here instead: https://github.com/fatiando/boule/tree/master/.github/workflows We're also trying out a tool called nox. It's pretty nice to automate some tasks with Python instead of clunky Makefiles that don't work on Windows.

@seisman seisman requested a review from leouieda November 6, 2020 19:12
@seisman seisman requested review from weiji14 and removed request for weiji14 November 6, 2020 19:12
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.

These changes will have to be documented under MAINTENANCE.md. Could you remove mention of Travis CI PyPI deployments at https://github.com/GenericMappingTools/pygmt/blob/v0.2.0/MAINTENANCE.md#travis-ci and place it under the Github Actions section at https://github.com/GenericMappingTools/pygmt/blob/v0.2.0/MAINTENANCE.md#github-actions instead please?

.github/workflows/publish-to-pypi.yml Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
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.

Getting there! Just one minor suggestion to change 'archive' to 'wheel'.

MAINTENANCE.md Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
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.

Cool, thanks for doing this @seisman, and to @leouieda for your experience on the fatiando side! This will really streamline our CI going forward 😄

P.S. remember to disable the Pull Request trigger.

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 this pull request may close these issues.

3 participants