Skip to content

Commit

Permalink
ci: add GitHub Actions linter
Browse files Browse the repository at this point in the history
  • Loading branch information
ashishb committed Jan 9, 2025
1 parent 89aed9b commit 50cdb57
Show file tree
Hide file tree
Showing 5 changed files with 83 additions and 0 deletions.
74 changes: 74 additions & 0 deletions .github/workflows/lint-github-actions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Generated by Gabo (https://github.com/ashishb/gabo)
---
# Run this locally with act - https://github.com/nektos/act
# act -j lintGitHubActions
name: Lint GitHub Actions

on: # yamllint disable-line rule:truthy
push:
branches: [master, main]
paths:
- ".github/workflows/**.yml"
- ".github/workflows/**.yaml"
pull_request:
branches: [master, main]
paths:
- ".github/workflows/**.yml"
- ".github/workflows/**.yaml"

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
lintGitHubActionsWithActionLint:
runs-on: ubuntu-latest
timeout-minutes: 15

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
persist-credentials: false
sparse-checkout: |
.github/workflows
sparse-checkout-cone-mode: false

- name: Lint GitHub Actions
uses: reviewdog/action-actionlint@v1

- name: Check GitHub Actions with 'actionlint'
# Ref: https://github.com/rhysd/actionlint/blob/main/docs/usage.md#use-actionlint-on-github-actions
# shellcheck is too noisy and disabled
run: |
bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)
./actionlint -color -shellcheck=
shell: bash


lintGitHubActionsForSecurity:
runs-on: ubuntu-latest
timeout-minutes: 15

permissions:
security-events: write
contents: read
actions: read

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
persist-credentials: false
sparse-checkout: |
.github/workflows
sparse-checkout-cone-mode: false

- name: Setup Rust
uses: actions-rust-lang/setup-rust-toolchain@v1

- name: Install zizmor
run: cargo install zizmor

- name: Run zizmor on GitHub Actions
run: zizmor .github/workflows/*
2 changes: 2 additions & 0 deletions .github/workflows/lint-markdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ jobs:
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Set up Ruby
# See https://github.com/ruby/setup-ruby#versioning
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/lint-shell-script.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ jobs:
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Run ShellCheck
uses: ludeeus/[email protected]
3 changes: 3 additions & 0 deletions .github/workflows/lint-yaml.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Check YAML files with linter
uses: ibiqlik/action-yamllint@v3
with:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/validate-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ jobs:

- name: Checkout code
uses: actions/checkout@v4
with:
persist-credentials: false

- uses: actions/cache@v4
with:
Expand Down

0 comments on commit 50cdb57

Please sign in to comment.