mirror of https://github.com/tektoncd/catalog.git synced 2024-11-22 06:02:51 +00:00

History

Chmouel Boudjnah bddd282012 Centralize all the git-clone apply task to a common function Centralize all the the git-clone apply commands we had around the pre-apply-task-hook to a central common function. This will make easier to have the same git-clone task version used everywhere. Add some documentation about the helper functions along the way. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>		2020-07-24 15:00:01 +01:00
..
tests	Centralize all the git-clone apply task to a common function	2020-07-24 15:00:01 +01:00
pylint.yaml	Fix pytest and pylint task	2020-07-24 11:42:00 +01:00
README.md	Add pylint and pytest task	2020-07-23 09:47:00 +01:00

README.md

pylint

The task provides linting based on pylint for Python. The used images are based on the official Docker Hub Python images. The installation of the packages is performed via a pip install.

It is required that pylint is part of the requirements file for the task. If the module is not included a warning will be printed.

Install the Task

Workspaces

source: A Workspace volume containing the python code.

Install pylint

kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/task/pylint/0.1/pylint.yaml

Parameters

PYTHON: The used Python version, more precisely the tag for the Python image (default: 3.6)
SOURCE_PATH: The path to the source code (default: .)
MODULE_PATH: The path to the module which should be analysed by pylint (default: .)
ARGS: The additional arguments to be used with pylint
REQUIREMENTS_FILE: The name of the requirements file inside the source location (default: requirements.txt)

Usage

This TaskRun runs pylint on a repository.

apiVersion: tekton.dev/v1beta1
kind: TaskRun
metadata:
  name: lint
spec:
  taskRef:
    name: pylint
  workspaces:
  - name: source
    persistentVolumeClaim:
      claimName: my-source
  params:
  - name: PYTHON
    value: "3.7"
  - name: MODULE
    value: "examples/custom.py"
  - name: ARGS
    value: "-r y"