Skip to content

actionlint docs #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 21, 2024
Merged

actionlint docs #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1e39da1
actionlint docs
cr-ruhanmuzaffar Aug 20, 2024
687e10b
fix: order and tech
cr-ruhanmuzaffar Aug 20, 2024
c527689
review
cr-ruhanmuzaffar Aug 21, 2024
84622c1
words change"
cr-ruhanmuzaffar Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/tools/actionlint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/)
9 changes: 6 additions & 3 deletions docs/tools/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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] |
Expand All @@ -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
Expand All @@ -76,4 +78,5 @@ Remove extraneous f prefix
[Checkov]: ./checkov.md
[Detekt]: ./detekt.md
[Rubocop]: ./rubocop.md
[Buf]: ./buf.md
[Buf]: ./buf.md
[Actionlint]: ./actionlint.md