From 1e39da1e5edb2c989e94c45854eb8da180b54972 Mon Sep 17 00:00:00 2001 From: Ruhan Date: Tue, 20 Aug 2024 23:11:58 +0530 Subject: [PATCH 1/4] actionlint docs --- docs/tools/actionlint.md | 27 +++++++++++++++++++++++++++ docs/tools/tools.md | 5 ++++- 2 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 docs/tools/actionlint.md diff --git a/docs/tools/actionlint.md b/docs/tools/actionlint.md new file mode 100644 index 00000000..66a470a8 --- /dev/null +++ b/docs/tools/actionlint.md @@ -0,0 +1,27 @@ +--- +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 + +Actionlint will run on files with the following extensions: + +- `.yml` +- `.yaml` + +We look for `.yaml` / `.yml` 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 ed811e0e..753bde4e 100644 --- a/docs/tools/tools.md +++ b/docs/tools/tools.md @@ -61,6 +61,8 @@ Remove extraneous f prefix | YAML | [YamlLint][YamlLint] | | Ruby | [Rubocop][Rubocop] | | Buf | [Buf][Buf] | +| Actionlint | [Actionlint][Actionlint] | + [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 From 687e10b4f497f19bd198cb9ae30072261805a9a7 Mon Sep 17 00:00:00 2001 From: Ruhan Date: Tue, 20 Aug 2024 23:16:38 +0530 Subject: [PATCH 2/4] fix: order and tech --- docs/tools/tools.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/tools/tools.md b/docs/tools/tools.md index 753bde4e..38735561 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,15 +55,13 @@ 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] | -| Actionlint | [Actionlint][Actionlint] | [ShellCheck]: ./shellcheck.md From c527689dbf34664b4e61683dc379fe23b46d03d4 Mon Sep 17 00:00:00 2001 From: Ruhan Date: Wed, 21 Aug 2024 17:13:04 +0530 Subject: [PATCH 3/4] review --- docs/tools/actionlint.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/tools/actionlint.md b/docs/tools/actionlint.md index 66a470a8..d9b5cba1 100644 --- a/docs/tools/actionlint.md +++ b/docs/tools/actionlint.md @@ -8,11 +8,6 @@ description: CodeRabbit's guide to Actionlint. ## Files -Actionlint will run on files with the following extensions: - -- `.yml` -- `.yaml` - We look for `.yaml` / `.yml` files specifically in the following directory: - `.github/workflows/**/*.yml` From 84622c1c1a9f5d4abdce37c4d9ef06713106f80b Mon Sep 17 00:00:00 2001 From: Ruhan Date: Wed, 21 Aug 2024 20:59:36 +0530 Subject: [PATCH 4/4] words change" --- docs/tools/actionlint.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/actionlint.md b/docs/tools/actionlint.md index d9b5cba1..95d403ec 100644 --- a/docs/tools/actionlint.md +++ b/docs/tools/actionlint.md @@ -8,7 +8,7 @@ description: CodeRabbit's guide to Actionlint. ## Files -We look for `.yaml` / `.yml` files specifically in the following directory: +We look for `Github Action` files specifically in the following directory: - `.github/workflows/**/*.yml` - `.github/workflows/**/*.yaml"`