From cf7d6f3c995b234db93ea8fa9564bde52e86ca2d Mon Sep 17 00:00:00 2001
From: Philipp Bammes <p.bammes@inpsyde.com>
Date: Thu, 26 Sep 2024 12:22:57 +0200
Subject: [PATCH] docs: add documentation

---
 README.md              |  1 +
 docs/lint-workflows.md | 15 +++++++++++++++
 2 files changed, 16 insertions(+)
 create mode 100644 docs/lint-workflows.md

diff --git a/README.md b/README.md
index dca429dd..af650a6e 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/docs/lint-workflows.md b/docs/lint-workflows.md
new file mode 100644
index 00000000..d9c465a5
--- /dev/null
+++ b/docs/lint-workflows.md
@@ -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
+```