Riege Software Code Quality

Linter configurations and GitHub workflows for linting source code.

Super Linter

Use this workflow if your repository consists of multiple file formats (e.g. Java, XML, Terraform). The Super Linter action is quite a beast but there is virtually nothing this action cannot lint.

Add a new workflow file like this one or add the following lines to a existing workflow:

call-lint-workflow:
uses: "riege/code-quality/.github/workflows/super-linter.yml@v1.0.0"

Optional input to enable kubeval for Kubernetes manifests:

call-lint-workflow:
uses: "riege/code-quality/.github/workflows/super-linter.yml@v1.0.0"
with:
  VALIDATE_KUBERNETES_KUBEVAL: true

Optional input to control which files kubeval validates:

call-lint-workflow:
uses: "riege/code-quality/.github/workflows/super-linter.yml@v1.0.0"
with:
  VALIDATE_KUBERNETES_KUBEVAL: true
  KUBERNETES_KUBEVAL_FILE_NAME: \\.ya?ml$

Optional input to enable GitHub Actions validation:

call-lint-workflow:
uses: "riege/code-quality/.github/workflows/super-linter.yml@v1.0.0"
with:
  VALIDATE_GITHUB_ACTIONS: true

Optional input to enable Checkov validation:

call-lint-workflow:
uses: "riege/code-quality/.github/workflows/super-linter.yml@v1.0.0"
with:
  VALIDATE_CHECKOV: true

Optional input to enable Gitleaks validation:

call-lint-workflow:
uses: "riege/code-quality/.github/workflows/super-linter.yml@v1.0.0"
with:
  VALIDATE_GITLEAKS: true

Optional input to enable ShellCheck validation:

call-lint-workflow:
uses: "riege/code-quality/.github/workflows/super-linter.yml@v1.0.0"
with:
  VALIDATE_BASH: true

Optional input to enable Markdown Prettier validation:

call-lint-workflow:
uses: "riege/code-quality/.github/workflows/super-linter.yml@v1.0.0"
with:
  VALIDATE_MARKDOWN_PRETTIER: true

Optional input to enable YAML Prettier validation:

call-lint-workflow:
uses: "riege/code-quality/.github/workflows/super-linter.yml@v1.0.0"
with:
  VALIDATE_YAML_PRETTIER: true

Optional input to enable Markdown validation in include mode:

call-lint-workflow:
uses: "riege/code-quality/.github/workflows/super-linter.yml@v1.0.0"
with:
  VALIDATE_MARKDOWN: true

Optional input to enable YAML validation in include mode:

call-lint-workflow:
uses: "riege/code-quality/.github/workflows/super-linter.yml@v1.0.0"
with:
  VALIDATE_YAML: true

Terraform

The workflow terraform.yml is intended for repositories consisting of Terraform files only. It's small and fast and properly checks Terraform configurations.

Usage:

jobs:
  lint:
    uses: riege/code-quality/.github/workflows/terraform.yml@v1.0.0
    with:
      skip_init: false
      skip_validate: false
    secrets: inherit

• use skip_init: true if terraform init doesn't work properly during workflow run.
• use skip_validate: true if terraform validate doesn't work properly during workflow run.
• use secrets: inherit if you need access to Terraform Cloud e.g. to use Terraform workspaces in data sources.