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 documentation deployment from Travis CI to GitHub Actions #713

Merged
merged 9 commits into from
Dec 10, 2020

Conversation

seisman
Copy link
Member

@seisman seisman commented Dec 3, 2020

Description of proposed changes

This is the last step of the CI migration from Travis to GitHub Actions.

The codes are copied from https://github.com/fatiando/boule/blob/master/.github/workflows/docs.yml.

For testing purpose, the deployment steps are enabled for PRs temporarily, and the documentation is deployed to the gh-pages-testing branch.

It seems working very well (see https://github.com/GenericMappingTools/pygmt/tree/gh-pages-testing).

Fixes #566.

TODO

  • Revert the changes in commit 4ed4de6
  • Remove .travis.yml
  • Remove the Travis badge in README
  • Update CONTRIBUTING.md
  • Update MAINTENANCE.md

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

Comment on lines +10 to +12
release:
types:
- published
Copy link
Member Author

Choose a reason for hiding this comment

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

Also trigger builds for tags/releases.

.github/workflows/ci_tests.yaml Outdated Show resolved Hide resolved
.github/workflows/ci_tests.yaml Outdated Show resolved Hide resolved
.github/workflows/ci_tests.yaml Outdated Show resolved Hide resolved
@seisman seisman requested a review from a team December 3, 2020 16:46
@seisman seisman added the maintenance Boring but important stuff for the core devs label Dec 3, 2020
@seisman seisman added this to the 0.3.0 milestone Dec 3, 2020
@seisman seisman marked this pull request as ready for review December 3, 2020 16:46
@seisman
Copy link
Member Author

seisman commented Dec 6, 2020

Ping @GenericMappingTools/python for review.

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.

Sorry for the delay in review. A quick scan and this seems fine to me, though I would prefer if @leouieda (who has more experience on Github Actions docs deploy) take another look. Otherwise, I think you can make the necessary pre-merge changes mentioned at https://github.com/GenericMappingTools/pygmt/pull/713/files#r535384202 and other places.

@seisman seisman merged commit 2a88f73 into master Dec 10, 2020
@seisman seisman deleted the migrate-docs branch December 10, 2020 19:40
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.

Migrate Travis CI jobs to GitHub Actions
2 participants