jenkinsfilelint 1.1.0

A Jenkinsfile linter that validates Jenkinsfiles using Jenkins API

Jenkinsfile Lint

A Python-based Jenkinsfile linter that validates Jenkinsfiles using Jenkins API.

Contents

• Features
• Installation
• Usage
• How It Works
• Requirements
• License

Features

• Validates Jenkinsfiles using Jenkins REST API
• Works as a pre-commit hook
• Supports both command-line usage and environment variables for configuration
• Requires Jenkins credentials for validation

Installation

Using pip

pip install jenkinsfilelint

Using pre-commit

Add this to your .pre-commit-config.yaml:

repos:
  - repo: https://github.com/shenxianpeng/jenkinsfilelint
    rev: # or specific version tag
    hooks:
      - id: jenkinsfilelint

Usage

[!IMPORTANT] jenkinsfilelint requires Jenkins credentials to be set via environment variables for validation:

• JENKINS_URL: Your Jenkins server URL (required)
• JENKINS_USER: Your Jenkins username (required unless anonymous access is enabled)
• JENKINS_TOKEN: Your Jenkins API token (required unless anonymous access is enabled)

Command Line

Validation requires Jenkins credentials. Set them using environment variables:

export JENKINS_URL=https://your-jenkins-instance.com
export JENKINS_USER=your-username
export JENKINS_TOKEN=your-api-token

jenkinsfilelint path/to/Jenkinsfile

Or using command-line arguments:

jenkinsfilelint path/to/Jenkinsfile \
  --jenkins-url https://your-jenkins-instance.com \
  --username your-username \
  --token your-api-token

Validate multiple files:

jenkinsfilelint Jenkinsfile Jenkinsfile.prod tests/Jenkinsfile

Pre-commit Hook

Create or update .pre-commit-config.yaml in your repository:

repos:
  - repo: https://github.com/shenxianpeng/jenkinsfilelint
    rev: # or specific version tag
    hooks:
      - id: jenkinsfilelint

Then install the pre-commit hook:

pre-commit install

How It Works

The linter sends the Jenkinsfile to your Jenkins instance's /pipeline-model-converter/validate endpoint for validation. Jenkins credentials (URL, username, and API token) are required.

Requirements

• Python 3.6+
• Jenkins server with Pipeline plugin installed

License

MIT License