Separate workflows for running tests and building documentation by seisman · Pull Request #1033 · GenericMappingTools/pygmt

seisman · 2021-03-10T04:48:53Z

Description of proposed changes

As mentioned in #830, this PR separates the current "Tests" workflow into two workflows to speedup our CI jobs.

ci_test.yaml: runs the full tests
ci_docs.yml: build the documentation and deploy it on master branch

TODO

Trigger workflows only if necessary (i.e., add paths and paths-ignore to push and pull_request)
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.

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

…n 3.9

weiji14

Ok with the CI test changes, just a few comments on the inline docs.

Still can't believe that the macOS CI test can take 17min, only 2min down from 19min. That's slower than the Windows CI 14min!!!

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

seisman · 2021-03-15T04:10:47Z

Still can't believe that the macOS CI test can take 17min, only 2min down from 19min. That's slower than the Windows CI 14min!!!

The macOS CI takes only 9 minutes in the previous runs (https://github.com/GenericMappingTools/pygmt/runs/2081311267). Let's see what happens in the next runs.

weiji14

Please also update the master branch protection at https://github.com/GenericMappingTools/pygmt/settings/branches to include these 3 (Linux/macOS/Windows) docs build workflows.

seisman · 2021-03-15T04:19:23Z

One thing to note is that we're inconsistently using .yaml and .yml for the workflow files. Both work but I personally prefer .yml.

Currently, this PR uses ci_test.yaml and ci_docs.yml.

weiji14 · 2021-03-15T04:24:07Z

One thing to note is that we're inconsistently using .yaml and .yml for the workflow files. Both work but I personally prefer .yml.
Currently, this PR uses ci_test.yaml and ci_docs.yml.

Probably best to do the renaming in a separate PR. We've are also been inconsistently using hyphens and underscores in https://github.com/GenericMappingTools/pygmt/tree/v0.3.1/.github/workflows.

Oh, and just noticed that we probably need a badge for ci_docs.yml for the main README.rst page?

seisman · 2021-03-15T04:39:04Z

Probably best to do the renaming in a separate PR. We've are also been inconsistently using hyphens and underscores in https://github.com/GenericMappingTools/pygmt/tree/v0.3.1/.github/workflows.

So keep using ci_docs.yml and ci_test.yaml in this PR, and rename ci_test.yaml to ci_test.yml and others in a separate PR, right?

Oh, and just noticed that we probably need a badge for ci_docs.yml for the main README.rst page?

Is it useful to you? I usually check the status of the latest commit, not the badges:

I feel that the badges are only useful telling new users that the package on master branch is running well and please try it, so the "Docs" build status is less useful.

weiji14 · 2021-03-15T04:44:45Z

Probably best to do the renaming in a separate PR. We've are also been inconsistently using hyphens and underscores in https://github.com/GenericMappingTools/pygmt/tree/v0.3.1/.github/workflows.
So keep using ci_docs.yml and ci_test.yaml in this PR, and rename ci_test.yaml to ci_test.yml and others in a separate PR, right?

Yes, and we can argue about hyphens and underscores again (plus change the README badges to point to the new filenames in that PR too).

Oh, and just noticed that we probably need a badge for ci_docs.yml for the main README.rst page?
Is it useful to you? I usually check the status of the latest commit, not the badges:
I feel that the badges are only useful telling new users that the package on master branch is running well and please try it, so the "Docs" build status is less useful.

True, no need to add it then. All good to merge!

…ricMappingTools#1033) Separates the current "Tests" workflow into two workflows to speedup our CI jobs. - ci_test.yaml: runs the full tests - ci_docs.yml: build the documentation and deploy it on master branch Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

seisman added 2 commits March 9, 2021 23:39

Make a copy from ci_test.yaml
2872225

Delete the documentation building part from Tests workflow
2b1cfbd

seisman force-pushed the separate-workflows branch from b422000 to 4adf973Compare March 10, 2021 04:49

vercelBottemporarily deployed to Preview March 10, 2021 04:55 Inactive

seisman force-pushed the separate-workflows branch from 4adf973 to 5bbad55Compare March 10, 2021 05:22

vercelBottemporarily deployed to Preview March 10, 2021 05:22 Inactive

Delete testing part from Docs workflow and only build docs with Pytho…
4578d0a
…n 3.9

seisman force-pushed the separate-workflows branch from 5bbad55 to 4578d0aCompare March 10, 2021 05:47

vercelBottemporarily deployed to Preview March 10, 2021 05:47 Inactive

Only install required pacakges
2dbcf85

vercelBottemporarily deployed to Preview March 10, 2021 17:19 Inactive

Install myst_parser
98d4110

seisman force-pushed the separate-workflows branch from 95002be to 98d4110Compare March 10, 2021 21:07

Add ipython
bdb345c

vercelBottemporarily deployed to Preview March 10, 2021 21:34 Inactive

Install required packages for testing
10a9a10

seisman force-pushed the separate-workflows branch from 54d56da to 10a9a10Compare March 10, 2021 21:43

vercelBottemporarily deployed to Preview March 10, 2021 21:43 Inactive

seisman marked this pull request as ready for review March 10, 2021 22:06

seisman marked this pull request as draft March 10, 2021 22:06

Merge branch 'master' into separate-workflows
d35b74b

vercelBottemporarily deployed to Preview March 12, 2021 05:20 Inactive

weiji14 mentioned this pull request Mar 13, 2021
Initialize data version control for managing test images #1036
Merged
5 tasks

Merge branch 'master' into separate-workflows
c98f9cd

vercelBottemporarily deployed to Preview March 13, 2021 21:32 Inactive

seisman added 2 commits March 13, 2021 17:04

Set default shell
f06df1b

Fix a typo
9c2bbab

vercelBottemporarily deployed to Preview March 13, 2021 22:06 Inactive

seisman changed the title ~~WIP: Separate workflows for running tests and building documentation~~Separate workflows for running tests and building documentationMar 13, 2021

Improve the trigger condition
7c1b769

vercelBottemporarily deployed to Preview March 13, 2021 22:36 Inactive

weiji14 reviewed Mar 14, 2021
View reviewed changes

Comment thread.github/workflows/ci_tests.yaml Outdated

Rename docs.yml to ci_docs.yml
6072215

vercelBottemporarily deployed to Preview March 15, 2021 01:34 Inactive

vercelBottemporarily deployed to Preview March 15, 2021 03:07 Inactive

Sort packages alphabetically
0c4b311

seisman force-pushed the separate-workflows branch from 8a77170 to 0c4b311Compare March 15, 2021 03:08

seisman added 2 commits March 14, 2021 23:11

Merge branch 'master' into separate-workflows
aa316c4

Add information of ci_docs.yml workflow to MAINTENANCE.md
45487cb

seisman marked this pull request as ready for review March 15, 2021 03:14

seisman added the maintenance Boring but important stuff for the core devs label Mar 15, 2021

seisman added this to the 0.4.0 milestone Mar 15, 2021

vercelBottemporarily deployed to Preview March 15, 2021 03:14 Inactive

weiji14 reviewed Mar 15, 2021
View reviewed changes

Comment threadMAINTENANCE.md Outdated
Comment threadMAINTENANCE.md Outdated
Comment thread.github/workflows/ci_tests.yaml

Apply suggestions from code review
e8ac103
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

vercelBottemporarily deployed to Preview March 15, 2021 04:06 Inactive

weiji14 approved these changes Mar 15, 2021
View reviewed changes

seisman merged commit d5b8f8a into masterMar 15, 2021

seisman deleted the separate-workflows branch March 15, 2021 04:52

This was referenced Mar 15, 2021
WIP: Parallelize Continuous Integration test and documentation build #830
Closed
WIP: Setup poetry in pyproject.toml #1055
Closed
Adopt NEP29 - drop support for Python 3.6 and NumPy 1.16 #690
Closed

weiji14 mentioned this pull request Oct 3, 2021
Add tomli as a dependency in GitHub Actions CI #1564
Merged
5 tasks

Navigation Menu

Uh oh!

Separate workflows for running tests and building documentation - #1033

Separate workflows for running tests and building documentation#1033
seisman merged 17 commits into
masterfrom
separate-workflows

seisman commented Mar 10, 2021•
edited
Loading

Uh oh!

Uh oh!

weiji14 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman commented Mar 15, 2021

Uh oh!

weiji14 left a comment •
edited
Loading

Uh oh!

seisman commented Mar 15, 2021

Uh oh!

weiji14 commented Mar 15, 2021•
edited
Loading

Uh oh!

seisman commented Mar 15, 2021

Uh oh!

weiji14 commented Mar 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

seisman commented Mar 10, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

weiji14 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman commented Mar 15, 2021

Uh oh!

weiji14 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

seisman commented Mar 15, 2021

Uh oh!

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

Uh oh!

Uh oh!

seisman commented Mar 15, 2021

Uh oh!

weiji14 commented Mar 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

seisman commented Mar 10, 2021•
edited
Loading

weiji14 left a comment •
edited
Loading

weiji14 commented Mar 15, 2021•
edited
Loading