Skip to content

Commit 0c45553

Browse files
actionlint docs (#79)
* actionlint docs * fix: order and tech * review * words change"
1 parent 4bd6187 commit 0c45553

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

docs/tools/actionlint.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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+
We look for `Github Action` files specifically in the following directory:
12+
13+
- `.github/workflows/**/*.yml`
14+
- `.github/workflows/**/*.yaml"`
15+
16+
## Configuration
17+
18+
CodeRabbit will use the default configuration.
19+
20+
## Links
21+
22+
- [Actionlint Configuration](https://github.com/rhysd/actionlint/blob/main/docs/config.md/)

docs/tools/tools.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ Remove extraneous f prefix
3939
| Technology | Tools |
4040
|:----------------------------|:-----------------------------------------------------------|
4141
| All | [Gitleaks][Gitleaks] |
42+
| GitHub Actions | [Actionlint][Actionlint] |
43+
| Protobuf | [Buf][Buf] |
4244
| CloudFormation | [Checkov][Checkov] |
4345
| CSS | [Biome][Biome] |
4446
| Docker | [Hadolint][Hadolint], [Checkov][Checkov] |
@@ -53,14 +55,14 @@ Remove extraneous f prefix
5355
| PHP | [PHPStan][PHPStan] |
5456
| Plaintext | [LanguageTool][LanguageTool] |
5557
| Python | [Ruff][Ruff] |
58+
| Ruby | [Rubocop][Rubocop] |
5659
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] |
5760
| Swift | [SwiftLint][SwiftLint] |
5861
| Terraform | [Checkov][Checkov] |
5962
| TSX | [Biome][Biome] |
6063
| Typescript | [Biome][Biome] |
6164
| YAML | [YamlLint][YamlLint] |
62-
| Ruby | [Rubocop][Rubocop] |
63-
| Buf | [Buf][Buf] |
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)