title	description
tekton-lint configuration in MegaLinter	How to use tekton-lint (configure, ignore files, ignore errors, help & version documentations) to analyze TEKTON files

tekton-lint

tekton-lint is a specialized linter designed for validating Tekton CI/CD pipeline files and ensuring they follow best practices. It provides comprehensive validation of Tekton Tasks, Pipelines, and other Kubernetes-native CI/CD resources.

Key Features:

Tekton-Specific Validation: Deep understanding of Tekton resource types, parameters, workspaces, and volume claims
YAML Syntax Checking: Validates proper YAML structure and formatting in pipeline definitions
Resource Reference Validation: Ensures that references between Tasks, Pipelines, and other resources are correct and valid
Best Practices Enforcement: Checks for adherence to Tekton development guidelines and conventions
Required Fields Verification: Validates that all mandatory fields and properties are present and properly configured
Early Error Detection: Catches configuration issues before pipeline deployment to Tekton clusters
Comprehensive Rule Set: Covers common Tekton anti-patterns and configuration mistakes

tekton-lint documentation

Version in MegaLinter: 1.1.0
Visit Official Web Site{target=_blank}
See How to configure tekton-lint rules{target=_blank}
See Index of problems detected by tekton-lint{target=_blank}

{target=_blank}

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 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_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 name Use `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
all	Default MegaLinter Flavor	126
c_cpp	Optimized for pure C/C++ projects	56
documentation	MegaLinter for documentation projects	49
dotnet	Optimized for C, C++, C# or VB based projects	64
dotnetweb	Optimized for C, C++, C# or VB based projects with JS/TS	73
go	Optimized for GO based projects	51
java	Optimized for JAVA based projects	54
javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	59
php	Optimized for PHP based projects	54
python	Optimized for PYTHON based projects	65
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

Dockerfile commands :

# renovate: datasource=npm depName=@ibm/tekton-lint
ARG NPM_IBM_TEKTON_LINT_VERSION=1.1.0

NPM packages (node.js):
- @ibm/tekton-lint@1.1.0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!