tekton-lint
tekton-lint documentation
- Version in MegaLinter: 1.1.0
- Visit Official Web Site
- See How to configure tekton-lint rules
- See Index of problems detected by tekton-lint
Configuration in MegaLinter
- Enable tekton-lint by adding
TEKTON_TEKTON_LINT
in ENABLE_LINTERS variable - Disable tekton-lint by adding
TEKTON_TEKTON_LINT
in DISABLE_LINTERS variable
Variable | Description | Default value |
---|---|---|
TEKTON_TEKTON_LINT_ARGUMENTS | User custom arguments to add in linter CLI call Ex: -s --foo "bar" |
|
TEKTON_TEKTON_LINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter Ex: -s --foo "bar" |
|
TEKTON_TEKTON_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter Ex: (src\|lib) |
Include every file |
TEKTON_TEKTON_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter Ex: (test\|examples) |
Exclude no file |
TEKTON_TEKTON_LINT_CLI_LINT_MODE | Override default CLI lint mode - file : Calls the linter for each file- project : Call the linter from the root of the project |
file |
TEKTON_TEKTON_LINT_FILE_EXTENSIONS | Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all filesEx: [".py", ""] |
[".yml", ".yaml"] |
TEKTON_TEKTON_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: ["Dockerfile(-.+)?", "Jenkinsfile"] |
Include every file |
TEKTON_TEKTON_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None |
TEKTON_TEKTON_LINT_POST_COMMANDS | List of bash commands to run after the linter | None |
TEKTON_TEKTON_LINT_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling TEKTON_TEKTON_LINT and its pre/post commands | None |
TEKTON_TEKTON_LINT_CONFIG_FILE | tekton-lint configuration file nameUse LINTER_DEFAULT to let the linter find it |
.tektonlintrc.yaml |
TEKTON_TEKTON_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules |
TEKTON_TEKTON_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | false |
TEKTON_TEKTON_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | 0 |
TEKTON_TEKTON_LINT_CLI_EXECUTABLE | Override CLI executable | ['tekton-lint'] |
MegaLinter Flavors
This linter is available in the following flavors
Flavor | Description | Embedded linters | Info | |
---|---|---|---|---|
all | Default MegaLinter Flavor | 122 | ||
c_cpp | Optimized for pure C/C++ projects | 54 | ||
documentation | MegaLinter for documentation projects | 49 | ||
dotnet | Optimized for C, C++, C# or VB based projects | 61 | ||
dotnetweb | Optimized for C, C++, C# or VB based projects with JS/TS | 70 | ||
go | Optimized for GO based projects | 51 | ||
java | Optimized for JAVA based projects | 52 | ||
javascript | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 59 | ||
php | Optimized for PHP based projects | 54 | ||
python | Optimized for PYTHON based projects | 62 | ||
ruby | Optimized for RUBY based projects | 50 | ||
rust | Optimized for RUST based projects | 50 | ||
salesforce | Optimized for Salesforce based projects | 54 | ||
swift | Optimized for SWIFT based projects | 50 | ||
terraform | Optimized for TERRAFORM based projects | 54 |
Behind the scenes
How are identified applicable files
- File extensions:
.yml
,.yaml
- Detected file content (regex):
apiVersion: tekton
How the linting is performed
- tekton-lint is called one time by identified file (
file
CLI lint mode)
Example calls
tekton-lint myfile.yml
Help content
tekton-lint [<options>] <glob-pattern-to-yaml-files> ...
Options:
--watch Run tekton-lint in watch mode [boolean] [default: false]
--color Forcefully enable/disable colored output
[boolean] [default: true]
--format Format output. Available formatters: vscode | stylish | json
[string] [choices: "vscode", "stylish", "json"] [default: "stylish"]
--quiet Report errors only [boolean] [default: false]
--max-warnings Number of warnings to trigger nonzero exit code
[number] [default: -1]
--config location of the .tektonlintrc.yaml, defaults to cwd
[string] [default: "/"]
--refresh-cache If true will delete the cache directory for external tasks
[boolean] [default: "false"]
--version Show version number [boolean]
--help Show help [boolean]
Examples:
tekton-lint "**/*.yaml" Globstar matching
tekton-lint path/to/my/pipeline.yaml Multiple glob patterns
"path/to/my/tasks/*.yaml"
tekton-lint --watch "**/*.yaml" Watch mode
Installation on mega-linter Docker image
- NPM packages (node.js):