Skip to content

Commit cf7d6f3

Browse files
committed
docs: add documentation
1 parent be791e6 commit cf7d6f3

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ groups here:
3939

4040
* Assets linting and formatting with [`@wordpress/scripts`](./docs/wp-scripts.md)
4141
* Linting, formatting, and testing tools for [PHP](./docs/php.md)
42+
* [Linting GitHub Actions workflow files](./docs/lint-workflows.md)
4243
* Unit tests for [JavaScript](./docs/js.md)
4344
* Assets compilation with [Composer Asset Compiler](./docs/assets-compilation.md) or
4445
the [Build and push](./docs/build-and-push-assets.md) approach

docs/lint-workflows.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Lint GitHub Actions workflows
2+
3+
This workflow runs [actionlint](https://github.com/rhysd/actionlint). It does so by executing the
4+
linter inside a Docker container using the official `actionlint` Docker image.
5+
6+
**Example:**
7+
8+
```yml
9+
name: Lint GitHub Actions workflows
10+
on:
11+
pull_request:
12+
jobs:
13+
lint-workflows:
14+
uses: inpsyde/reusable-workflows/.github/workflows/lint-workflows.yml@main
15+
```

0 commit comments

Comments
 (0)