From 7b5e31a5b94139acc88161a0c201847a73be3103 Mon Sep 17 00:00:00 2001
From: Guy Sartorelli <36352093+GuySartorelli@users.noreply.github.com>
Date: Fri, 5 Apr 2024 10:03:47 +1300
Subject: [PATCH] NEW Add documentation linting option (#112)

---
 .github/workflows/ci.yml | 5 +++++
 README.md                | 4 ++++
 2 files changed, 9 insertions(+)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 9f333cf..8882d9f 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -39,6 +39,9 @@ on:
       js:
         type: boolean
         default: true
+      doclinting:
+        type: boolean
+        default: true
       preserve_vendor_tests:
         type: boolean
         default: false
@@ -104,6 +107,7 @@ jobs:
           phplinting: ${{ inputs.phplinting }}
           phpunit: ${{ inputs.phpunit }}
           js: ${{ inputs.js }}
+          doclinting: ${{ inputs.doclinting }}
 
   # For each job in the matrix, setup an environment and run the tests
   tests:
@@ -803,6 +807,7 @@ jobs:
           endtoend_suite: ${{ matrix.endtoend_suite }}
           endtoend_config: ${{ matrix.endtoend_config }}
           js: ${{ matrix.js }}
+          doclinting: ${{ matrix.doclinting }}
 
       - name: Output latest SHA
         id: output-sha
diff --git a/README.md b/README.md
index f76a7ba..5df5a2a 100644
--- a/README.md
+++ b/README.md
@@ -75,6 +75,10 @@ Create a smaller matrix with only the lowest supported PHP and MySQL versions in
 Dynamically generate a matrix using feature detection. If disabled, jobs must be defined using the extra_jobs input. Default is true, disable with:
 `dynamic_matrix: false`
 
+##### Documentation linting
+Runs linting against documentation using [silverstripe/documentation-lint](https://github.com/silverstripe/documentation-lint/) if the `.doclintrc` config file is available. Default is true, disable with:
+`doclinting: false`
+
 ##### PHPUnit tests
 Runs PHPunit if the `phpunit.xml` or `phpunit.xml.dist` config file is available. Default is true, disable PHPunit tests with:
 `phpunit: false`