You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: add actionlint to CI and pre-commit for workflow validation
Add actionlint as a step in the Code Quality CI workflow using the
SHA-pinned raven-actions/actionlint action (v2.1.2, actionlint 1.7.12).
Add .pre-commit-config.yaml with markdownlint and actionlint hooks.
Update CONTRIBUTING.md with pre-commit setup instructions.
Ref: RHAIENG-4067
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-12Lines changed: 21 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,31 +16,40 @@ Before submitting, please read our [Code of Conduct](CODE_OF_CONDUCT.md). By par
16
16
17
17
## Linting and formatting
18
18
19
-
This project uses [ruff](https://docs.astral.sh/ruff/)for Python linting and formatting, and [markdownlint](https://github.com/DavidAnson/markdownlint) for Markdown linting. Both run as blocking CI checks on all pull requests via the `Code Quality` workflow.
19
+
This project uses [ruff](https://docs.astral.sh/ruff/)(Python), [markdownlint](https://github.com/DavidAnson/markdownlint) (Markdown), and [actionlint](https://github.com/rhysd/actionlint) (GitHub Actions workflows). All three run as blocking CI checks on every pull request via the `Code Quality` workflow.
20
20
21
-
### Python (ruff)
21
+
Markdownlint and actionlint are configured as [pre-commit](https://pre-commit.com/) hooks. Set up once and they run automatically on every commit:
22
22
23
-
Run locally before pushing:
23
+
```bash
24
+
uv tool install pre-commit
25
+
pre-commit install
26
+
```
27
+
28
+
To run all hooks manually against the entire repo:
24
29
25
30
```bash
26
-
uv tool install ruff==0.15.11
27
-
ruff check .# lint
28
-
ruff format --check .# format check
29
-
ruff format .# auto-format
31
+
pre-commit run --all-files
30
32
```
31
33
32
-
Configuration is in [`ruff.toml`](ruff.toml) at the repo root.
34
+
To run a specific linter:
33
35
34
-
### Markdown (markdownlint)
36
+
```bash
37
+
pre-commit run markdownlint-cli2 --all-files # Markdown lint
38
+
pre-commit run actionlint --all-files # GitHub Actions workflow lint
Configuration is in[`.markdownlint.jsonc`](.markdownlint.jsonc) (rules) and [`.markdownlint-cli2.yaml`](.markdownlint-cli2.yaml) (ignored paths) at the repo root.
0 commit comments