Files

Jon Lockwood d610562438 feat(python_linting): added ci job, python linting, code quality and scoring

Added a job to lint python files and ouput a code quality report for gitlab MR.

A html report is also available within the artifacts. if the badge is used,
the badge links to the html code quality report.

 Changes to be committed:
	modified:   .gitlab-ci.yml
	new file:   python/.gitlab-ci.yml
	new file:   python/README.md
	new file:   python/requirements.txt

issue #1

2021-08-11 15:51:45 +09:30

2.4 KiB

Raw Permalink Blame History

Python

This folder (python) covers jobs for python development

These jobs provides the following badge:

PyLint - code quality

Use the following MD to add a badge adjusting the variables and ensuring everything is on one line.

[![PyLint Score](https://img.shields.io/badge/dynamic/json?&style=plastic&logo=python&label=PyLint%20Score&query=%24.PyLintScore&url=https%3A%2F%2Fgitlab.com%2F

{project path}

%2F-%2Fjobs%2Fartifacts%2F

{branch}

%2Fraw%2Fartifacts%2Fvalidation%2FPyLint%2Fbadge_pylint.json%3Fjob%3D

{Job Name}

)](https://gitlab.com/

{project path}

/-/jobs/artifacts/

{branch}

/file/

artifacts/validation/tests/gl-code-quality-report.html

?job=

{Job Name}
)

Variable	Description
`{project path}`	project path, what's after gitlab.com/
`{branch}`	git branch to fetch the score from
`{Job Name}`	name of the gitlab-ci job for the linting

Dependencies

None

your .gitlab-ci.yml changes

To add the PyLint job, add the following to your .gitlab-ci.yml file

stages:
    - validation

include:
    - remote: https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/raw/master/python/.gitlab-ci.yml

PyLint:
    variables:
        PYLINT_PATH: "/*/*.py"
    extends:
        - .PyLint
    image: python:3.6-slim

CI/CD Variables required

var name	Description
PYLINT_PATH	The path you wish the linter to search for python files

Job Workflow

This job will lint any yaml file in the specified directory using the specified rules.

Artifacts

$CI_PROJECT_DIR/artifacts - Root artifact directory
$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.json - Gitlab code quality report (displays in merge request)
$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.html - html code quality report

License

To view the license for this folder and any sub-folders, refer here

2.4 KiB Raw Permalink Blame History