docs: Add example for GitHub Actions (#22)

contane · Dec 30, 2024 · 9807f8a · 9807f8a
1 parent 74afffb
commit 9807f8a
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 # Default ignored files
+.DS_Store
 .idea
+.vscode
 .env
diff --git a/README.md b/README.md
@@ -24,6 +24,21 @@ To run `yamllint` on the current directory:
 docker run --rm --user yamllint -v "$(pwd):/data" contane/yamllint -f colored .
 ```
 
+### GitHub Actions
+
+To use this image in a GitHub Actions workflow, add the following to your `.github/workflows/*.yml`:
+
+```yaml
+jobs:
+  yamllint:
+    runs-on: ubuntu-latest
+    container:
+      image: contane/yamllint
+    steps:
+      - uses: actions/checkout@v4
+      - run: yamllint -f colored .
+```
+
 ### GitLab CI
 
 To use this image in a GitLab CI pipeline, add the following to your `.gitlab-ci.yml`: