Skip to content

Commit

Permalink
docs: add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tyrann0us committed Sep 26, 2024
1 parent be791e6 commit cf7d6f3
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ groups here:

* Assets linting and formatting with [`@wordpress/scripts`](./docs/wp-scripts.md)
* Linting, formatting, and testing tools for [PHP](./docs/php.md)
* [Linting GitHub Actions workflow files](./docs/lint-workflows.md)
* Unit tests for [JavaScript](./docs/js.md)
* Assets compilation with [Composer Asset Compiler](./docs/assets-compilation.md) or
the [Build and push](./docs/build-and-push-assets.md) approach
Expand Down
15 changes: 15 additions & 0 deletions docs/lint-workflows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Lint GitHub Actions workflows

This workflow runs [actionlint](https://github.com/rhysd/actionlint). It does so by executing the
linter inside a Docker container using the official `actionlint` Docker image.

**Example:**

```yml
name: Lint GitHub Actions workflows
on:
pull_request:
jobs:
lint-workflows:
uses: inpsyde/reusable-workflows/.github/workflows/lint-workflows.yml@main
```

0 comments on commit cf7d6f3

Please sign in to comment.