Skip to content

Commit 1e39da1

Browse files
actionlint docs
1 parent 4efced5 commit 1e39da1

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

docs/tools/actionlint.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Actionlint
3+
sidebar_label: Actionlint
4+
description: CodeRabbit's guide to Actionlint.
5+
---
6+
7+
[Actionlint](https://github.com/rhysd/actionlint/) is a static checker for GitHub Actions workflow files.
8+
9+
## Files
10+
11+
Actionlint will run on files with the following extensions:
12+
13+
- `.yml`
14+
- `.yaml`
15+
16+
We look for `.yaml` / `.yml` files specifically in the following directory:
17+
18+
- `.github/workflows/**/*.yml`
19+
- `.github/workflows/**/*.yaml"`
20+
21+
## Configuration
22+
23+
CodeRabbit will use the default configuration.
24+
25+
## Links
26+
27+
- [Actionlint Configuration](https://github.com/rhysd/actionlint/blob/main/docs/config.md/)

docs/tools/tools.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ Remove extraneous f prefix
6161
| YAML | [YamlLint][YamlLint] |
6262
| Ruby | [Rubocop][Rubocop] |
6363
| Buf | [Buf][Buf] |
64+
| Actionlint | [Actionlint][Actionlint] |
65+
6466

6567
[ShellCheck]: ./shellcheck.md
6668
[Ruff]: ./ruff.md
@@ -76,4 +78,5 @@ Remove extraneous f prefix
7678
[Checkov]: ./checkov.md
7779
[Detekt]: ./detekt.md
7880
[Rubocop]: ./rubocop.md
79-
[Buf]: ./buf.md
81+
[Buf]: ./buf.md
82+
[Actionlint]: ./actionlint.md

0 commit comments

Comments
 (0)