gh-actions-workflows

Reusable GitHub Actions workflows for gitignore-in repositories.

Workflows

• actionlint.yml: runs rhysd/actionlint against the caller repository.
• markdownlint.yml: runs markdownlint-cli2 against the caller repository.
• spellcheck.yml: runs crate-ci/typos against the caller repository.

Caller repositories should keep only small workflow files that define the trigger, permissions, and jobs.<job_id>.uses reference. The reusable workflows run in the caller repository context after actions/checkout.

Caller Examples

Actionlint

name: Actionlint
on:
  pull_request:
permissions:
  contents: read
jobs:
  actionlint:
    uses: gitignore-in/gh-actions-workflows/.github/workflows/actionlint.yml@main

Callers can customize the checked files and ShellCheck behavior:

jobs:
  actionlint:
    uses: gitignore-in/gh-actions-workflows/.github/workflows/actionlint.yml@main
    with:
      files: ".github/workflows/*.yml action.yml"
      shellcheck-enabled: false

The files input is passed unquoted to the shell so that glob patterns expand normally. Pass one or more space-separated shell glob patterns. Paths containing spaces are not supported. When overriding actionlint-version, pass an actionlint release tag such as v1.7.12. The workflow validates the tag format before invoking go run.

The legacy shellcheck: disabled input is accepted for compatibility, but new callers should prefer shellcheck-enabled: false.

Spellcheck

name: Spellcheck
on:
  pull_request:
permissions:
  contents: read
jobs:
  check:
    uses: gitignore-in/gh-actions-workflows/.github/workflows/spellcheck.yml@main

If a repository needs to check a non-root path or a custom typos configuration, pass explicit inputs from the caller workflow:

jobs:
  check:
    uses: gitignore-in/gh-actions-workflows/.github/workflows/spellcheck.yml@main
    with:
      files: docs
      config: .github/typos.toml

Development

This repository dogfoods its reusable workflows through .github/workflows/ci.yml.

Local checks:

actionlint
typos

Markdownlint

name: Markdownlint
on:
  pull_request:
permissions:
  contents: read
jobs:
  markdownlint:
    uses: gitignore-in/gh-actions-workflows/.github/workflows/markdownlint.yml@main
    with:
      globs: "README.md docs/*.md"

A .markdownlint.json in the caller repository is picked up automatically by markdownlint-cli2.