diff --git a/src/app.ts b/src/app.ts index 504674b5..2e5b28b3 100644 --- a/src/app.ts +++ b/src/app.ts @@ -140,7 +140,7 @@ export class App { ]; const docLintingRegularExpressions: RegExp[] = [ - /(^mkdocs.yml|docs?\/book\/.*\.md$)/ + /(^mkdocs.yml|docs?\/book\/.*\.md|README.md$)/ ]; diff.forEach( diff --git a/src/tools.ts b/src/tools.ts index 835a476e..2178b7a9 100644 --- a/src/tools.ts +++ b/src/tools.ts @@ -64,6 +64,13 @@ export default function createTools(config: Config): Array { 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/code-check-deprecated-exclusion-via-config/.laminas-ci.json b/tests/code-check-deprecated-exclusion-via-config/.laminas-ci.json index 40bfd69f..5e2d656c 100644 --- a/tests/code-check-deprecated-exclusion-via-config/.laminas-ci.json +++ b/tests/code-check-deprecated-exclusion-via-config/.laminas-ci.json @@ -9,6 +9,9 @@ }, { "name": "PHPUnit on PHP 7.4 with latest dependencies" + }, + { + "name": "README Linting on PHP 7.4 with locked dependencies" } ] } diff --git a/tests/doc-linting-readme-due-diff/.laminas-ci.json b/tests/doc-linting-readme-due-diff/.laminas-ci.json new file mode 100644 index 00000000..a912e7b6 --- /dev/null +++ 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 new file mode 100644 index 00000000..e69de29b diff --git a/tests/doc-linting-readme-due-diff/matrix.json b/tests/doc-linting-readme-due-diff/matrix.json new file mode 100644 index 00000000..66f843ca --- /dev/null +++ b/tests/doc-linting-readme-due-diff/matrix.json @@ -0,0 +1,10 @@ +{ + "include": [ + { + "name": "README 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 new file mode 100644 index 00000000..a912e7b6 --- /dev/null +++ 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 new file mode 100644 index 00000000..e69de29b diff --git a/tests/doc-linting-readme/diff b/tests/doc-linting-readme/diff new file mode 100644 index 00000000..b43bf86b --- /dev/null +++ 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 new file mode 100644 index 00000000..66f843ca --- /dev/null +++ b/tests/doc-linting-readme/matrix.json @@ -0,0 +1,10 @@ +{ + "include": [ + { + "name": "README 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" + } + ] +}