tekton-lint

tekton-lint documentation

Version in MegaLinter: 0.6.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_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 files Ex: `[".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_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`

MegaLinter Flavours

This linter is available in the following flavours

Flavor	Description	Embedded linters
all	Default MegaLinter Flavor	114
documentation	MegaLinter for documentation projects	48
dotnet	Optimized for C, C++, C# or VB based projects	60
go	Optimized for GO based projects	50
java	Optimized for JAVA based projects	51
javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	57
php	Optimized for PHP based projects	51
python	Optimized for PYTHON based projects	59
ruby	Optimized for RUBY based projects	48
rust	Optimized for RUST based projects	48
salesforce	Optimized for Salesforce based projects	51
swift	Optimized for SWIFT based projects	48
terraform	Optimized for TERRAFORM based projects	53

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

Usage:
tekton-lint <path-to-yaml-files>

Options:
$ tekton-lint --watch                # Run tekton-lint in watch mode
$ tekton-lint --version              # Show version number
$ tekton-lint --help                 # Show help
$ tekton-lint --color / --no-color   # Forcefully enable/disable colored output
$ tekton-lint --format               # Format output. Available formatters: vscode (default) | stylish | json
$ tekton-lint --quiet                # Report errors only - default: false
$ tekton-lint --max-warnings <Int>   # Number of warnings to trigger nonzero exit code - default: -1

Examples:
# Globstar matching
$ tekton-lint '**/*.yaml'

# Exact file path
$ tekton-lint my-pipeline.yaml my-task.yaml

# Multiple glob patterns
$ tekton-lint path/to/my/pipeline.yaml 'path/to/my/tasks/*.yaml'

# Watch mode
$ tekton-lint --watch '**/*.yaml'

Installation on mega-linter Docker image

NPM packages (node.js):
- tekton-lint