Due to some maintenance issues, this service has been switched in read-only mode, you can find more information about the why

and how to migrate your plugin documentation in this blogpost

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Plugin Information

View JenkinsLint on the plugin site for more information.


Detects whether your Jenkins configuration follows those best practices 

This plugin has mainly two goals:

  • To make it easier to detect issues in your Jenkins configuration that will cause Jenkins to blow up when you attempt to run those jobs.
  • To encourage discussion within the Jenkins community on the more subjective stuff. Having a set of checks to base discussion on helps drive out what we as a community think is good style.

Summary

Jenkins is an awesome Automation System, and there are a bunch of people using it in different ways, for example: developers, testers, automation, build engineers, release engineers, scrum master, product owner and so on. Unfortunately, as the number of jobs grows, maintaining them becomes tedious, and the paradigm of no using a predefined set of best practices falls apart.

The Jenkins Lint plugin attempts to solve this problem by allowing jobs to be evaluated with some predefined best practices. The goal is for your team to be able to define those best practices to be related to their project.

Manually reviewing those jobs wouldn't be too hard, but doing the same thing all over again for every new job or for a hundred other projects is where it gets difficult and tedious. This provides a much more powerful way of analyzing them.

You can find it under <jenkins_url>/jenkinslint or reach it via links in the sidepanel of the main page

Screenshot

Features

List of available checks:

  • Artifact Publisher check
  • CleanUp Workspace check
  • Git Shallow clone check
  • Javadoc Publisher check
  • Job Assigned Label check
  • Master Assigned Label check
  • Job Description check
  • Job Log Rotator check
  • Job Name check
  • Maven Job Type check
  • Null SCM check
  • Polling SCM Trigger check
  • Multibranch Job Type check

Control comments:
You can ignore a particular check  by adding a trailing lint:ignore:<check name> comment to the job description.

Planned upcoming features

  • Load checks dynamically via Reflection.
  • Show graphs.
  • Configure Checks (enabled, disabled, change severity)
  • Load checks dynamically via Jenkins.
  • Jobs action to show those jenkins lints.
  • Define some kind of programmatically scripts.

Requirements

Jenkins

Jenkins version 1.554.1 or newer is required.

Version history

Version 0.1.0

  • Initial release
  • No labels