Skip to content

Commit 9d51cbe

Browse files
committed
Reusable workflows: make the accepted config file names more explicit
Includes updating the documentation about this in the README.
1 parent f3b0cdb commit 9d51cbe

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

.github/workflows/reusable-markdownlint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
id: has_config
1919
uses: andstor/file-existence-action@076e0072799f4942c8bc574a82233e1e4d13e9d6 # v3.0.0
2020
with:
21-
files: ".markdownlint-cli2.y*ml"
21+
files: ".markdownlint-cli2.yml, .markdownlint-cli2.yaml"
2222

2323
# @link https://github.com/marketplace/actions/problem-matcher-for-markdownlint-cli
2424
- name: Enable showing issue in PRs

.github/workflows/reusable-phpstan.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
id: has_config
3030
uses: andstor/file-existence-action@076e0072799f4942c8bc574a82233e1e4d13e9d6 # v3.0.0
3131
with:
32-
files: "phpstan.neon*"
32+
files: "phpstan.neon.dist, phpstan.neon"
3333

3434
- name: Create tools string
3535
id: tools

.github/workflows/reusable-yamllint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
id: has_config
2525
uses: andstor/file-existence-action@076e0072799f4942c8bc574a82233e1e4d13e9d6 # v3.0.0
2626
with:
27-
files: ".yamllint.y*ml"
27+
files: ".yamllint.yml, .yamllint.yaml"
2828

2929
- name: Run Yamllint on all yaml files in repo
3030
if: ${{ steps.has_config.outputs.files_exists == 'true' }}

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ It also means that, as the configuration for each tool is always in a committed
3232

3333
The following re-usable workflows are available:
3434
* [`reusable-markdownlint.yml`][reusable-markdownlint] which runs a (code-style) [linter for Markdown/CommonMark files][markdownlint-cli2].
35-
**Requires**: a `.markdownlint-cli2.y*ml` configuration file in the project root.
35+
**Requires**: a `.markdownlint-cli2.yml` or `.markdownlint-cli2.yaml` configuration file in the project root.
3636
* [`reusable-phpstan.yml`][reusable-phpstan] which runs the [PHPStan] tool.
37-
**Requires**: a `phpstan.neon*` configuration file in the project root.
37+
**Requires**: a `phpstan.neon.dist` or `phpstan.neon` configuration file in the project root.
3838
**Inputs**:
3939
- `phpVersion`: Optional. The PHP version to use. Defaults to 'latest'.
4040
- `phpstanVersion`: Optional. The PHPStan version to use. Defaults to the latest available version.
@@ -45,7 +45,7 @@ The following re-usable workflows are available:
4545
- `fail-on-warnings`: Optional. Whether to exit as failed when there are warnings. Defaults to "true".
4646
* [`reusable-yamllint.yml`][reusable-yamllint] which runs two linters for Yaml files.
4747
1. [yamllint] which checks all YAML files for syntax validity, code style and runs some QA checks too.
48-
**Requires**: a `.yamllint.y*ml` configuration file in the project root.
48+
**Requires**: a `.yamllint.yml` or `.yamllint.yaml` configuration file in the project root.
4949
**Inputs**:
5050
+ `strict`: Optional. Whether to enable strict mode. Defaults to "false".
5151
2. [actionlint] which runs a static analysis check on GitHub Actions workflow files only.

0 commit comments

Comments
 (0)