Sets heavy GitHub CI workflows to not trigger on text documentation-only changes. (#2417)

Sets heavy GitHub CI workflows to not trigger on docs-only changes.

Specifically, sets azure-ci-dispatcher.yml and therock-ci.yml, as well as many rocprofiler workflows, to not trigger when the change consists entirely of docs-only files.

Author: dsclear-amd

.github/scripts/therock_configure_ci.py

@@ -88,15 +88,16 @@ def check_for_workflow_file_related_to_ci(paths: Optional[Iterable[str]]) -> boo
     "docs/*",
     ".gitignore",
     "*.md",
+    "*.rtf",
     "*.rst",
+    "*/.markdownlint-ci2.yaml",
+    "*/.readthedocs.yaml",
+    "*/.spellcheck.local.yaml",
+    "*/.wordlist.txt",
     "projects/*/docs/*",
     "projects/*/.gitignore",
-    "projects/*/*.md",
-    "projects/*/*.rst",
     "shared/*/docs/*",
     "shared/*/.gitignore",
-    "shared/*/*.md",
-    "shared/*/*.rst",
 ]
 
 

.github/workflows/azure-ci-dispatcher.yml

@@ -26,6 +26,16 @@ on:
       - staging
       - main
       - release-staging/rocm-rel-7.*
+    paths-ignore:  # Do not trigger full tests on documentation-only changes
+      - '**/*.md'
+      - '**/*.rtf'
+      - '**/*.rst'
+      - '**/.markdownlint-ci2.yaml'
+      - '**/.readthedocs.yaml'
+      - '**/.spellcheck.local.yaml'
+      - '**/.wordlist.txt'
+      - 'docs/**'
+      - 'projects/*/docs/**'
 
 concurrency:
   group: azure-ci-dispatcher-${{ github.event.pull_request.number || github.ref }}

.github/workflows/rocprofiler-compute-continuous-integration.yml

@@ -19,23 +19,33 @@ on:
     paths:
       - '.github/workflows/rocprofiler-compute-continuous-integration.yml'
       - 'projects/rocprofiler-compute/**'
-      - '!projects/rocprofiler-compute/*.md'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-compute/docs/**'
       - '!projects/rocprofiler-compute/source/docs/**'
       - '!projects/rocprofiler-compute/source/python/gui/**'
       - '!projects/rocprofiler-compute/docker/**'
-      - '!projects/rocprofiler-compute/.wordlist.txt'
       - '!projects/rocprofiler-compute/CMakePresets.json'
   pull_request:
     paths:
       - '.github/workflows/rocprofiler-compute-continuous-integration.yml'
       - 'projects/rocprofiler-compute/**'
-      - '!projects/rocprofiler-compute/*.md'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-compute/docs/**'
       - '!projects/rocprofiler-compute/source/docs/**'
       - '!projects/rocprofiler-compute/source/python/gui/**'
       - '!projects/rocprofiler-compute/docker/**'
-      - '!projects/rocprofiler-compute/.wordlist.txt'
       - '!projects/rocprofiler-compute/CMakePresets.json'
 
 env:

.github/workflows/rocprofiler-compute-formatting.yml

@@ -10,6 +10,15 @@ on:
     paths:
       - '.github/workflows/rocprofiler-compute-formatting.yml'
       - 'projects/rocprofiler-compute/**'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
+      - '!docs/**'
+      - '!projects/*/docs/**'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/rocprofiler-compute-rhel-8.yml

@@ -10,16 +10,26 @@ on:
     paths:
       - '.github/workflows/rocprofiler-compute-rhel-8.yml'
       - 'projects/rocprofiler-compute/**'
-      - '!projects/rocprofiler-compute/*.md'
-      - '!projects/rocprofiler-compute/.github/**/*.md'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-compute/docs/**'
       - '!projects/rocprofiler-compute/docker/**'
   pull_request:
     paths:
       - '.github/workflows/rocprofiler-compute-rhel-8.yml'
       - 'projects/rocprofiler-compute/**'
-      - '!projects/rocprofiler-compute/*.md'
-      - '!projects/rocprofiler-compute/.github/**/*.md'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-compute/docs/**'
       - '!projects/rocprofiler-compute/docker/**'
 

.github/workflows/rocprofiler-compute-tarball.yml

@@ -7,14 +7,26 @@ on:
     paths:
       - '.github/workflows/rocprofiler-compute-tarball.yml'
       - 'projects/rocprofiler-compute/**'
-      - '!projects/rocprofiler-compute/*.md'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-compute/docs/**'
       - '!projects/rocprofiler-compute/docker/**'
   pull_request:
     paths:
       - '.github/workflows/rocprofiler-compute-tarball.yml'
       - 'projects/rocprofiler-compute/**'
-      - '!projects/rocprofiler-compute/*.md'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-compute/docs/**'
       - '!projects/rocprofiler-compute/docker/**'
 

.github/workflows/rocprofiler-compute-ubuntu-jammy.yml

@@ -9,16 +9,26 @@ on:
     paths:
       - '.github/workflows/rocprofiler-compute-ubuntu-jammy.yml'
       - 'projects/rocprofiler-compute/**'
-      - '!projects/rocprofiler-compute/*.md'
-      - '!projects/rocprofiler-compute/.github/**/*.md'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-compute/docs/**'
       - '!projects/rocprofiler-compute/docker/**'
   pull_request:
     paths:
       - '.github/workflows/rocprofiler-compute-ubuntu-jammy.yml'
       - 'projects/rocprofiler-compute/**'
-      - '!projects/rocprofiler-compute/*.md'
-      - '!projects/rocprofiler-compute/.github/**/*.md'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-compute/docs/**'
       - '!projects/rocprofiler-compute/docker/**'
 

.github/workflows/rocprofiler-register-continuous-integration.yml

@@ -6,13 +6,25 @@ on:
       - develop
     paths:
       - 'projects/rocprofiler-register/**'
-      - '!projects/rocprofiler-register/*.md'
       - '.github/workflows/rocprofiler-register-continuous-integration.yml'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
   pull_request:
     paths:
       - 'projects/rocprofiler-register/**'
-      - '!projects/rocprofiler-register/*.md'
       - '.github/workflows/rocprofiler-register-continuous-integration.yml'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/rocprofiler-sdk-code_coverage.yml

@@ -11,19 +11,29 @@ on:
       - develop
     paths:
       - 'projects/rocprofiler-sdk/**'
+      - '.github/workflows/rocprofiler-sdk-code_coverage.yml'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-sdk/CODEOWNERS'
       - '!projects/rocprofiler-sdk/source/docs/**'
-      - '!projects/rocprofiler-sdk/*.md'
-      - '!projects/rocprofiler-sdk/**/README.md'
-      - '.github/workflows/rocprofiler-sdk-code_coverage.yml'
   pull_request:
     paths:
       - 'projects/rocprofiler-sdk/**'
+      - '.github/workflows/rocprofiler-sdk-code_coverage.yml'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-sdk/CODEOWNERS'
       - '!projects/rocprofiler-sdk/source/docs/**'
-      - '!projects/rocprofiler-sdk/*.md'
-      - '!projects/rocprofiler-sdk/**/README.md'
-      - '.github/workflows/rocprofiler-sdk-code_coverage.yml'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/rocprofiler-sdk-codeql.yml

@@ -6,19 +6,31 @@ on:
     paths:
       - '.github/workflows/rocprofiler-sdk-codeql.yml'
       - 'projects/rocprofiler-sdk/**'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-sdk/CODEOWNERS'
       - '!projects/rocprofiler-sdk/source/docs/**'
-      - '!projects/rocprofiler-sdk/*.md'
 
   push:
     branches:
       - develop
     paths:
       - '.github/workflows/rocprofiler-sdk-codeql.yml'
       - 'projects/rocprofiler-sdk/**'
+      - '!**/*.md'
+      - '!**/*.rtf'
+      - '!**/*.rst'
+      - '!**/.markdownlint-ci2.yaml'
+      - '!**/.readthedocs.yaml'
+      - '!**/.spellcheck.local.yaml'
+      - '!**/.wordlist.txt'
       - '!projects/rocprofiler-sdk/CODEOWNERS'
       - '!projects/rocprofiler-sdk/source/docs/**'
-      - '!projects/rocprofiler-sdk/*.md'
 
 env:
   ROCM_PATH: "/opt/rocm"