CI: Trigger workflows based on changed files (#2952)

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

.github/workflows/benchmarks.yml

@@ -11,13 +11,9 @@ on:
     branches: [ main ]
     paths:
       - 'pygmt/**/*.py'
-      - '!pygmt/tests/**'
-      - '.github/workflows/benchmarks.yml'
-  pull_request:
-    paths:
-      - 'pygmt/**/*.py'
-      - '!pygmt/tests/**'
       - '.github/workflows/benchmarks.yml'
+  # Uncomment the 'pull_request' line below to trigger the workflow in PR
+  # pull_request:
   # `workflow_dispatch` allows CodSpeed to trigger backtest
   # performance analysis in order to generate initial data.
   workflow_dispatch:

.github/workflows/cache_data.yaml

@@ -5,14 +5,14 @@
 # by other GitHub Actions workflows.
 #
 # It is scheduled to run every Sunday at 12:00 (UTC). If new remote files are
-# needed urgently, maintainers can update the workflow file or
+# needed urgently, maintainers can update the workflow file or the
 # 'pygmt/helpers/caching.py' file to refresh the cache.
 #
 name: Cache data
 
 on:
   pull_request:
-    # Make any changes to the following files to refresh the cache
+    # Make any changes to the following files to refresh the cache in PRs
     paths:
       - 'pygmt/helpers/caching.py'
       - '.github/workflows/cache_data.yaml'

.github/workflows/ci_docs.yml

@@ -18,13 +18,22 @@ name: Docs
 on:
   push:
     branches: [ main ]
+    paths:
+      - 'pygmt/**/*.py'
+      - '!pygmt/tests/**'
+      - 'doc/**'
+      - 'examples/**'
+      - 'README.rst'
+      - '.github/workflows/ci_docs.yml'
   pull_request:
     types: [opened, reopened, synchronize, ready_for_review]
-    paths-ignore:
-      - 'pygmt/tests/**'
-      - '*.md'
-      - 'LICENSE.txt'
-      - '.gitignore'
+    paths:
+      - 'pygmt/**/*.py'
+      - '!pygmt/tests/**'
+      - 'doc/**'
+      - 'examples/**'
+      - 'README.rst'
+      - '.github/workflows/ci_docs.yml'
   release:
     types:
       - published

.github/workflows/ci_tests.yaml

@@ -25,15 +25,14 @@ name: Tests
 on:
   push:
     branches: [ main ]
+    paths:
+      - 'pygmt/**'
+      - '.github/workflows/ci_tests.yaml'
   pull_request:
     types: [opened, reopened, synchronize, ready_for_review]
-    paths-ignore:
-      - 'doc/**'
-      - 'examples/**'
-      - '*.md'
-      - 'README.rst'
-      - 'LICENSE.txt'
-      - '.gitignore'
+    paths:
+      - 'pygmt/**'
+      - '.github/workflows/ci_tests.yaml'
   release:
     types:
       - published

.github/workflows/ci_tests_dev.yaml

@@ -17,13 +17,9 @@ on:
   #   branches: [ main ]
   pull_request:
     types: [ready_for_review]
-    paths-ignore:
-      - 'doc/**'
-      - 'examples/**'
-      - '*.md'
-      - 'README.rst'
-      - 'LICENSE.txt'
-      - '.gitignore'
+    paths:
+      - 'pygmt/**'
+      - '.github/workflows/ci_tests_dev.yaml'
   repository_dispatch:
     types: [test-gmt-dev-command]
   # Schedule tests on Monday/Wednesday/Friday

.github/workflows/ci_tests_legacy.yaml

@@ -11,15 +11,12 @@ name: GMT Legacy Tests
 on:
   # push:
   #   branches: [ main ]
+  # Uncomment the 'pull_request' line below to trigger the workflow in PR
   # pull_request:
     # types: [ready_for_review]
-    # paths-ignore:
-    #  - 'doc/**'
-    #  - 'examples/**'
-    #  - '*.md'
-    #  - 'README.rst'
-    #  - 'LICENSE.txt'
-    #  - '.gitignore'
+    # paths:
+    #  - 'pygmt/**'
+    #  - '.github/workflows/ci_tests_legacy.yaml'
   # Schedule tests on Tuesday
   schedule:
     - cron: '0 0 * * 2'

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

@@ -17,8 +17,15 @@ name: Publish to PyPI
 # Only run for pushes to the main branch and releases.
 on:
   push:
-    branches:
-      - main
+    branches: [ main ]
+    paths:
+      - 'pygmt/**'
+      - '!pygmt/tests/**'
+      - 'Makefile'
+      - 'MANIFEST.in'
+      - 'pyproject.toml'
+      - 'README.rst'
+      - '.github/workflows/publish-to-pypi.yml'
   release:
     types:
       - published

.github/workflows/release-drafter.yml

@@ -8,7 +8,6 @@ name: Release Drafter
 
 on:
   push:
-    # branches to consider in the event; optional, defaults to all
     branches:
       - main
 

.github/workflows/type_checks.yml

@@ -10,7 +10,13 @@ name: Static Type Checks
 on:
   push:
     branches: [ main ]
+    paths:
+      - 'pygmt/**/*.py'
+      - '.github/workflows/type_checks.yml'
   pull_request:
+    paths:
+      - 'pygmt/**/*.py'
+      - '.github/workflows/type_checks.yml'
   # Schedule daily tests
   schedule:
     - cron: '0 0 * * *'