diff --git a/docs/tools/actionlint.md b/docs/tools/actionlint.md new file mode 100644 index 0000000..95d403e --- /dev/null +++ b/docs/tools/actionlint.md @@ -0,0 +1,22 @@ +--- +title: Actionlint +sidebar_label: Actionlint +description: CodeRabbit's guide to Actionlint. +--- + +[Actionlint](https://github.com/rhysd/actionlint/) is a static checker for GitHub Actions workflow files. + +## Files + +We look for `Github Action` files specifically in the following directory: + +- `.github/workflows/**/*.yml` +- `.github/workflows/**/*.yaml"` + +## Configuration + +CodeRabbit will use the default configuration. + +## Links + +- [Actionlint Configuration](https://github.com/rhysd/actionlint/blob/main/docs/config.md/) diff --git a/docs/tools/tools.md b/docs/tools/tools.md index ed811e0..3873556 100644 --- a/docs/tools/tools.md +++ b/docs/tools/tools.md @@ -39,6 +39,8 @@ Remove extraneous f prefix | Technology | Tools | |:----------------------------|:-----------------------------------------------------------| | All | [Gitleaks][Gitleaks] | +| GitHub Actions | [Actionlint][Actionlint] | +| Protobuf | [Buf][Buf] | | CloudFormation | [Checkov][Checkov] | | CSS | [Biome][Biome] | | Docker | [Hadolint][Hadolint], [Checkov][Checkov] | @@ -53,14 +55,14 @@ Remove extraneous f prefix | PHP | [PHPStan][PHPStan] | | Plaintext | [LanguageTool][LanguageTool] | | Python | [Ruff][Ruff] | +| Ruby | [Rubocop][Rubocop] | | Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | | Swift | [SwiftLint][SwiftLint] | | Terraform | [Checkov][Checkov] | | TSX | [Biome][Biome] | | Typescript | [Biome][Biome] | | YAML | [YamlLint][YamlLint] | -| Ruby | [Rubocop][Rubocop] | -| Buf | [Buf][Buf] | + [ShellCheck]: ./shellcheck.md [Ruff]: ./ruff.md @@ -76,4 +78,5 @@ Remove extraneous f prefix [Checkov]: ./checkov.md [Detekt]: ./detekt.md [Rubocop]: ./rubocop.md -[Buf]: ./buf.md \ No newline at end of file +[Buf]: ./buf.md +[Actionlint]: ./actionlint.md \ No newline at end of file