pylint-gitlab

Warnings

• breaking The official GitHub repository for pylint-gitlab is archived, with a recommendation to migrate to 'ruff' for GitLab Code Quality reports. While the PyPI package still receives updates, active development for new features or bug fixes may be limited, and users are encouraged to evaluate 'ruff' as an alternative.
  Fix: Consider migrating to 'ruff' which has built-in support for GitLab Code Quality reports. Refer to 'ruff' official documentation for migration guidance.
• gotcha When running Pylint in CI/CD, 'Unable to import' errors are common if Python dependencies are not properly installed or if the project's root is not on the `PYTHONPATH`. Pylint needs to correctly resolve imports to analyze code.
  Fix: Ensure all project dependencies are installed in the CI environment (e.g., using `pip install -r requirements.txt`). If your project structure involves custom import paths, add them to `sys.path` using `init-hook` in your `.pylintrc` or by manipulating `PYTHONPATH` in your CI script.
• gotcha Using `--exit-zero` with Pylint in CI prevents the job from failing due to linting errors, allowing the Code Quality report to be generated even if issues are found. Without it, the CI job might fail prematurely, preventing the report from being processed by GitLab.
  Fix: Include `--exit-zero` in your Pylint command within the CI script (e.g., `pylint --exit-zero ...`) to ensure the job completes and generates the artifact. If you want the pipeline to fail on a specific Pylint score, configure GitLab CI/CD's quality gates or use a custom script to evaluate the Pylint score output.
• gotcha For GitLab to display Code Quality results, the generated `codeclimate.json` file must be declared as a `codequality` report artifact in your `.gitlab-ci.yml` file. Failing to do so will result in the report not appearing in merge requests.
  Fix: Add an `artifacts` section to your CI job with `reports: codequality: codeclimate.json` (or your chosen output filename) to ensure the report is collected and processed by GitLab.
• gotcha Pylint (a core dependency) has specific Python version requirements (e.g., Pylint 3.x generally requires Python 3.10+). Ensure that the Python version used in your CI environment is compatible with the version of Pylint being installed (which `pylint-gitlab` will pull as a dependency).
  Fix: Verify the Python version used in your CI image (e.g., `python:3.10-slim`) is compatible with the Pylint version implicitly or explicitly installed. Check Pylint's release notes for its minimum Python requirements.

Install

• pip install pylint-gitlab Install latest version

Imports

• GitlabCodeClimateReporter

  from pylint_gitlab import GitlabCodeClimateReporter

  Used with '--output-format=pylint_gitlab.GitlabCodeClimateReporter' or '--load-plugins=pylint_gitlab --output-format=gitlab-codeclimate'.
• GitlabPagesHtmlReporter

  from pylint_gitlab import GitlabPagesHtmlReporter

  Used with '--output-format=pylint_gitlab.GitlabPagesHtmlReporter' or '--load-plugins=pylint_gitlab --output-format=gitlab-pages-html'.

Quickstart

This GitLab CI/CD configuration demonstrates how to integrate `pylint-gitlab` into your pipeline. It installs the library, creates a dummy Python file with a simple linting issue, runs Pylint using the `GitlabCodeClimateReporter` to generate a `codeclimate.json` file, and then declares this file as a `codequality` artifact, which GitLab will parse to display code quality metrics in merge requests.

# .gitlab-ci.yml
image: python:3.9-slim

pylint_job:
  stage: test
  before_script:
    - pip install pylint-gitlab
    - mkdir -p public # For HTML report if used
  script:
    - |-
      # Create a dummy Python file to lint
      echo "def func():\n  x = 1\n  return x" > my_module.py
      # Run pylint with the GitLab Code Climate reporter
      pylint --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter my_module.py > codeclimate.json
  artifacts:
    reports:
      codequality: codeclimate.json