feature: introduce markdown linting for README.md

Signed-off-by: Maximilian Bösing <[email protected]>
laminas · Jul 7, 2023 · e41599a · e41599a
1 parent f736154
commit e41599a
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 0 deletions.
diff --git a/src/tools.ts b/src/tools.ts
@@ -64,6 +64,13 @@ export default function createTools(config: Config): Array<Tool> {
             filesToCheck  : [ 'mkdocs.yml' ],
             toolType      : ToolType.LINTER,
         },
+        {
+            executionType : ToolExecutionType.STATIC,
+            name          : 'README Linting',
+            command       : 'markdownlint README.md',
+            filesToCheck  : [ 'README.md' ],
+            toolType      : ToolType.LINTER,
+        },
         {
             executionType     : ToolExecutionType.MATRIX,
             name              : 'PHPUnit',

diff --git a/tests/doc-linting-readme-due-diff/.laminas-ci.json b/tests/doc-linting-readme-due-diff/.laminas-ci.json
@@ -0,0 +1,3 @@
+{
+    "stablePHP": "7.4"
+}
diff --git a/tests/doc-linting-readme-due-diff/README.md b/tests/doc-linting-readme-due-diff/README.md
diff --git a/tests/doc-linting-readme-due-diff/matrix.json b/tests/doc-linting-readme-due-diff/matrix.json
@@ -0,0 +1,10 @@
+{
+    "include": [
+        {
+            "name": "Documentation Linting [7.4, latest]",
+            "job": "{\"command\":\"markdownlint README.md\",\"php\":\"7.4\",\"extensions\":[],\"ini\":[],\"dependencies\":\"latest\",\"ignore_platform_reqs_8\":false,\"ignore_php_platform_requirement\":false,\"additional_composer_arguments\":[],\"before_script\":[]}",
+            "operatingSystem": "ubuntu-latest",
+            "action": "laminas/laminas-continuous-integration-action@v1"
+        }
+    ]
+}
diff --git a/tests/doc-linting-readme/.laminas-ci.json b/tests/doc-linting-readme/.laminas-ci.json
@@ -0,0 +1,3 @@
+{
+    "stablePHP": "7.4"
+}
diff --git a/tests/doc-linting-readme/README.md b/tests/doc-linting-readme/README.md
diff --git a/tests/doc-linting-readme/diff b/tests/doc-linting-readme/diff
@@ -0,0 +1 @@
+README.md
diff --git a/tests/doc-linting-readme/matrix.json b/tests/doc-linting-readme/matrix.json
@@ -0,0 +1,10 @@
+{
+    "include": [
+        {
+            "name": "Documentation Linting [7.4, latest]",
+            "job": "{\"command\":\"markdownlint README.md\",\"php\":\"7.4\",\"extensions\":[],\"ini\":[],\"dependencies\":\"latest\",\"ignore_platform_reqs_8\":false,\"ignore_php_platform_requirement\":false,\"additional_composer_arguments\":[],\"before_script\":[]}",
+            "operatingSystem": "ubuntu-latest",
+            "action": "laminas/laminas-continuous-integration-action@v1"
+        }
+    ]
+}