Github Actions CI for testing GMT master branch #485

weiji14 · 2020-06-22T12:06:35Z

Description of proposed changes

Running Continuous Integration tests on the gmt-master branch. Based on code I had lying around on my computer from May 2020 (tested locally on https://github.com/nektos/act/), but updated with stuff from #475 et al.

This is similar to #462, but on Github Actions (instead of Azure Pipelines), and currently only on Ubuntu and macOS only (may try on Windows someday).

Fixes #345, Closes #462.

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.

Signed-off-by: Wei Ji <weiji.leong@vuw.ac.nz>

See https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast Signed-off-by: Wei Ji <weiji.leong@vuw.ac.nz>

Signed-off-by: Wei Ji <weiji.leong@vuw.ac.nz>

Try just caching ~/.gmt/cache and ~/.gmt/server.

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

.github/workflows/ci_tests.yaml

seisman · 2020-06-22T17:17:45Z

I'm thinking if it's easier and more cross-platform if we build the gmt master branch via conda-build and then install it, i.e.,

Clone the gmt-feedstock. Only the files in the recipe directory are needed
Update the source section in the meta.yml file to use the master branch source from git
Build the gmt package via conda build recipe -c conda-forge.
Install the local conda package via conda install gmt-xxxx.tar.gz.

weiji14 · 2020-06-22T19:12:45Z

That's a smart idea. But we might as well make gmt-nightly builds a thing and pull that (and users who want the latest bugfix can benefit).

The Rapids AI organization has a good documented example, see e.g. cudf https://anaconda.org/rapidsai-nightly/cudf/files and blog post at https://medium.com/rapids-ai/in-the-heat-of-the-nightlies-6ed3be57ac64. I seem to recall they designed the build so it only happens if there's been commits, so no compute time is wasted. I'll open an issue for that later.

seisman · 2020-06-22T19:45:10Z

Do you mean a separate gmt-nightly feedstock?

We actually have a devel branch in the gmt-feedstock, but I'm not sure if it's a good idea to have a nightly release, since the packages (Linux, macOS and Windows) would be almost 200 MB for each release.

Found this one conda-forge/cfep#3, but haven't read it yet.

weiji14 · 2020-06-22T21:51:04Z

I've started a new thread at conda-forge/gmt-feedstock#95. We can continue that part of the discussion there.

seisman · 2020-07-18T00:32:51Z

I think we should move the "testing GMT master branch" into a separate file. Sometimes it's impossible to make all the tests for the current release and master branch. Then we will always see a failing badge in the README file.

Also run the tests only on PRs that are ready for review or have a review requested (i.e. non-draft PRs). Based on https://github.saobby.my.eu.orgmunity/t/dont-run-actions-on-draft-pull-requests/16817/6.

weiji14 · 2020-07-22T08:37:06Z

README.rst

+    :alt: GitHub Actions Tests status
+    :target: https://github.com/GenericMappingTools/pygmt/actions?query=workflow%3ATests
+.. image:: https://github.com/GenericMappingTools/pygmt/workflows/GMT%20Master%20Tests/badge.svg
+    :alt: GitHub Actions GMT Master Tests status
+    :target: https://github.com/GenericMappingTools/pygmt/actions?query=workflow%3A"GMT+Master+Tests"


I think we should move the "testing GMT master branch" into a separate file. Sometimes it's impossible to make all the tests for the current release and master branch. Then we will always see a failing badge in the README file.

Ok, I've moved it into a separate file and added a separate badge. It would be nice if we could have separate badges for different jobs in a workflow but it doesn't look to be possible yet according to https://github.saobby.my.eu.orgmunity/t/separate-workflow-badges-when-using-matrix-testing-possible/16708.

weiji14 · 2020-07-22T08:43:03Z

.github/workflows/ci_tests_dev.yaml

+  pull_request:
+    types: [review_requested, ready_for_review]


Found this nice way to limit the GMT Master Tests to non-draft PRs (see https://github.saobby.my.eu.orgmunity/t/dont-run-actions-on-draft-pull-requests/16817/6 and also https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request). I think this strikes a nice balance between testing GMT master "on every PR commit" and testing "only on the PyGMT master branch". Let me know if this is okay.

As an aside, we could apply this to other expensive tests too (e.g. *coughs* Windows).

Looks a good idea. Do we still want to test GMT master when a PR is merged into master branch?

Do we still want to test GMT master when a PR is merged into master branch?

Up to you. I'd prefer to save on CI resources, and there's a daily cron job anyway.

OK. Daily cron job is enough.

I just made a new commit b911366 to this branch. The GMT master workflow is not triggered. I need to click the "Re-request review" icon to trigger the GMT master test.

I think It's good. The GMT master workflow only runs when:

A draft PR is ready for review

A review is request or re-request

Yes, it's a nice feature. We don't need to test this too often anyway so I'm happy with it 😄 Should I document this in MAINTENANCE.md?

Yes, please.

weiji14 · 2020-07-22T08:46:05Z

.github/workflows/ci_tests_dev.yaml

+      fail-fast: false
+      matrix:
+        python-version: [3.8]
+        os: [ubuntu-20.04, macOS-10.15]


Would love to test on Windows here, but I think we might have to do conda-forge/gmt-feedstock#95 first 😉

.github/workflows/ci_tests_dev.yaml

weiji14 · 2020-07-22T22:16:00Z

MAINTENANCE.md

+1. `ci_tests.yaml` (Style Checks, Tests on Linux/macOS/Windows)
+
+This is ran on every commit on the *master* and Pull Request branches.
+It is also scheduled to run daily on the *master* branch.


Ok, I've reorganized the Continuous Integration section a bit since it was getting complicated. You can insert a comment here about 'skipping ci-tests' later in #534.

weiji14 and others added 18 commits June 5, 2020 15:04

Run Continuous Integration tests on Github Actions

4c0fd39

Signed-off-by: Wei Ji <weiji.leong@vuw.ac.nz>

Install make earlier

31340ee

Signed-off-by: Wei Ji <weiji.leong@vuw.ac.nz>

Set Linux/MacOS environment variables properly

9a4e7bc

Signed-off-by: Wei Ji <weiji.leong@vuw.ac.nz>

Install pytest and other dev dependencies

51472dc

Signed-off-by: Wei Ji <weiji.leong@vuw.ac.nz>

Don't fail-fast and cancel all jobs

9c2e393

See https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast Signed-off-by: Wei Ji <weiji.leong@vuw.ac.nz>

Update setup-miniconda Github Action from v1 to v1.3.1

2220702

Signed-off-by: Wei Ji <weiji.leong@vuw.ac.nz>

Don't set any environment variables for all OSes

6936b3c

Cache GMT tutorial files in ${{ github.workspace }}/.gmt on 20200605

6906426

Try just caching ~/.gmt/cache and ~/.gmt/server.

Fix typo python_version to python-version

d2ce09b

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Fix python_version to python-version

e407081

Disable tests to enable caches

841f937

Re-enable tests to check caches

9fd73f0

Change github action name

1a23b55

Simplify job name

0ba3d7e

The versioneer pacakge need tags to determine the PyGMT version

c744db9

Change runner.os to matrix.os

3a06afc

Improve the docs

05c225f

Add a cron job for daily tests

8bd8a66

vercel bot temporarily deployed to Preview June 22, 2020 12:15 Inactive

vercel bot temporarily deployed to Preview June 22, 2020 12:35 Inactive

seisman reviewed Jun 22, 2020

View reviewed changes

.github/workflows/ci_tests.yaml Outdated Show resolved Hide resolved

weiji14 mentioned this pull request Jun 22, 2020

Create gmt weekly/nightly builds? conda-forge/gmt-feedstock#95

Open

seisman added 3 commits June 28, 2020 22:45

Merge branch 'master' into gh-actions-ci

d4408c0

Change earth_relief_60m to earth_relief_01d

c12cfff

Let conda install packages listed in requirements.txt

9179bc2

weiji14 force-pushed the gmt-master-gh-actions branch from 58cd99b to 3f136bb Compare June 29, 2020 04:39

Update cache key to 20200712 and use GMT 6.1.0 specific dataset names

575baa7

weiji14 force-pushed the gmt-master-gh-actions branch from 12f5b90 to 575baa7 Compare July 12, 2020 10:29

vercel bot temporarily deployed to Preview July 12, 2020 10:29 Inactive

Add ipython for test_figure_show

a4a6d7a

vercel bot temporarily deployed to Preview July 12, 2020 10:57 Inactive

Merge branch 'master' into gmt-master-gh-actions

e2518ef

vercel bot temporarily deployed to Preview July 16, 2020 08:35 Inactive

Use remote file cache artifacts from Github

65ec7ce

vercel bot temporarily deployed to Preview July 16, 2020 08:45 Inactive

weiji14 changed the title ~~WIP: Github Actions CI for testing GMT master branch~~ Github Actions CI for testing GMT master branch Jul 16, 2020

weiji14 mentioned this pull request Jul 18, 2020

Re-enable Windows builds #518

Merged

5 tasks

Merge remote-tracking branch 'origin/master' into gmt-master-gh-actions

80f8bf6

vercel bot temporarily deployed to Preview July 22, 2020 08:30 Inactive

Move GMT Master Tests to separate yaml file and add a badge for it

19c38d0

Also run the tests only on PRs that are ready for review or have a review requested (i.e. non-draft PRs). Based on https://github.saobby.my.eu.orgmunity/t/dont-run-actions-on-draft-pull-requests/16817/6.

weiji14 force-pushed the gmt-master-gh-actions branch from eff332b to 19c38d0 Compare July 22, 2020 08:31

vercel bot temporarily deployed to Preview July 22, 2020 08:31 Inactive

weiji14 commented Jul 22, 2020

View reviewed changes

weiji14 marked this pull request as ready for review July 22, 2020 20:26

seisman reviewed Jul 22, 2020

View reviewed changes

.github/workflows/ci_tests_dev.yaml Outdated Show resolved Hide resolved

No need to install gshhg-gmt and dcw-gmt

b911366

vercel bot temporarily deployed to Preview July 22, 2020 21:30 Inactive

seisman self-requested a review July 22, 2020 21:32

Mention GMT Master Tests in MAINTENANCE.md, and reorganize some sections

c174a1e

vercel bot temporarily deployed to Preview July 22, 2020 22:04 Inactive

weiji14 commented Jul 22, 2020

View reviewed changes

seisman approved these changes Jul 22, 2020

View reviewed changes

weiji14 merged commit bdc51d7 into master Jul 22, 2020

weiji14 deleted the gmt-master-gh-actions branch July 22, 2020 23:34

weiji14 mentioned this pull request Jan 26, 2021

Split meca into a standalone module from base_plotting.py #686

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Github Actions CI for testing GMT master branch #485

Github Actions CI for testing GMT master branch #485

weiji14 commented Jun 22, 2020 •

edited

Loading

seisman commented Jun 22, 2020

weiji14 commented Jun 22, 2020 •

edited

Loading

seisman commented Jun 22, 2020 •

edited

Loading

weiji14 commented Jun 22, 2020

seisman commented Jul 18, 2020

weiji14 Jul 22, 2020

weiji14 Jul 22, 2020

seisman Jul 22, 2020

weiji14 Jul 22, 2020

seisman Jul 22, 2020

seisman Jul 22, 2020

weiji14 Jul 22, 2020

seisman Jul 22, 2020

weiji14 Jul 22, 2020 •

edited

Loading

weiji14 Jul 22, 2020

Github Actions CI for testing GMT master branch #485

Github Actions CI for testing GMT master branch #485

Conversation

weiji14 commented Jun 22, 2020 • edited Loading

seisman commented Jun 22, 2020

weiji14 commented Jun 22, 2020 • edited Loading

seisman commented Jun 22, 2020 • edited Loading

weiji14 commented Jun 22, 2020

seisman commented Jul 18, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weiji14 Jul 22, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weiji14 commented Jun 22, 2020 •

edited

Loading

weiji14 commented Jun 22, 2020 •

edited

Loading

seisman commented Jun 22, 2020 •

edited

Loading

weiji14 Jul 22, 2020 •

edited

Loading