tekton-lint

tekton-lint documentation

• Version in Mega-Linter: 0.6.0
• Visit Official Web Site
• See How to configure tekton-lint rules
• See Index of problems detected by tekton-lint

Configuration in Mega-Linter

• 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 - list_of_files: Call the linter with the list of files as argument - project: Call the linter from the root of the project	{linter.cli_lint_mode}
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 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 Mega-Linter 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

Mega-Linter Flavours

This linter is available in the following flavours

	Flavor	Description	Embedded linters	Info
	all	Default Mega-Linter Flavor	94
	dart	Optimized for DART based projects	41
	documentation	Mega-Linter for documentation projects	40
	dotnet	Optimized for C, C++, C# or VB based projects	47
	go	Optimized for GO based projects	42
	java	Optimized for JAVA based projects	42
	javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	49
	php	Optimized for PHP based projects	44
	python	Optimized for PYTHON based projects	49
	ruby	Optimized for RUBY based projects	41
	rust	Optimized for RUST based projects	41
	salesforce	Optimized for Salesforce based projects	43
	scala	Optimized for SCALA based projects	41
	swift	Optimized for SWIFT based projects	41
	terraform	Optimized for TERRAFORM based projects	45

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

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

Example success log

Results of tekton-lint linter (version 0.5.2)
See documentation on https://megalinter.github.io/descriptors/tekton_tekton_lint/
-----------------------------------------------

[SUCCESS] .automation/test/tekton/good/tekton_good_1.yml
    .automation/test/tekton/good/tekton_good_1.yml:
    warning (20,14,20,20): Invalid image: 'ubuntu'. Specify the image tag instead of using ':latest'
    warning (22,14,22,51): Invalid image: 'gcr.io/example-builders/build-example'. Specify the image tag instead of using ':latest'
    warning (26,14,26,50): Invalid image: 'gcr.io/example-builders/push-example'. Specify the image tag instead of using ':latest'

Example error log

Results of tekton-lint linter (version 0.5.2)
See documentation on https://megalinter.github.io/descriptors/tekton_tekton_lint/
-----------------------------------------------

[ERROR] .automation/test/tekton/bad/tekton_bad_1.yml
    .automation/test/tekton/bad/tekton_bad_1.yml:
    warning (20,14,20,20): Invalid image: 'ubuntu'. Specify the image tag instead of using ':latest'
    warning (22,14,22,51): Invalid image: 'gcr.io/example-builders/build-example'. Specify the image tag instead of using ':latest'
    warning (26,14,26,50): Invalid image: 'gcr.io/example-builders/push-example'. Specify the image tag instead of using ':latest'
    error   (29,17,29,31): Task 'example-task-name' wants to mount volume 'example-volume' in step 'dockerfile-pushexample', but this volume is not defined.