Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 1.86 KB

config.md

File metadata and controls

52 lines (39 loc) · 1.86 KB
Raw

Configuration

This document describes how to configure actionlint behavior.

Note that configuration file is optional. The author tries to keep configuration file as minimal as possible not to bother users to configure behavior of actionlint. Running actionlint without configuration file would work fine in most cases.

Configuration file

Configuration file actionlint.yaml or actionlint.yml can be put in .github directory.

Note: If you're using Super-Linter, the file should be placed in a different directory. Please check the project's document.

You don't need to write the first configuration file by your hand. actionlint command can generate a default configuration with -init-config flag.

actionlint -init-config
vim .github/actionlint.yaml

Currently only one item can be configured.

self-hosted-runner:
  # Labels of self-hosted runner in array of string
  labels:
    - linux.2xlarge
    - windows-latest-xl
    - linux-multi-gpu
# Configuration variables in array of strings defined in your repository or organization
config-variables:
  - DEFAULT_RUNNER
  - JOB_NAME
  - ENVIRONMENT_STAGE
  • self-hosted-runner: Configuration for your self-hosted runner environment.
    • labels: Label names added to your self-hosted runners as list of pattern. Glob syntax supported by path.Match is available.
  • config-variables: Configuration variables. When an array is set, actionlint will check vars properties strictly. An empty array means no variable is allowed. The default value null disables the check.

Checks | Installation | Usage | Go API | References