View JenkinsLint on the plugin site for more information.
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.
SummaryJenkins 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.
UsageYou can find it under <jenkins_url>/jenkinslint or reach it via links in the sidepanel of the main page. You don't need to do anything else, just click on the Jenkins Lint link and those Lint checkers will be shown.
FeaturesList of available Job checks:
Artifact Publisher checkCleanUp Workspace checkGit Shallow clone checkJavadoc Publisher checkJob Assigned Label checkMaster Assigned Label checkJob Description checkJob Log Rotator checkJob Name checkMaven Job Type checkNull SCM checkPolling SCM Trigger checkMultibranch Job Type checkHard-coded Script checkGradle Wrapper checkBuilt Timeout checkGit Ref repo checkGroovy system exit check List of available Slave checks:
Slave description checkSlave label checkSlave version checkWindows slave launch checkPlanned upcoming featuresLoad 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.Rest API Git Submodule ref repo checkControl comments:
You can ignore a particular check by adding a trailing lint:ignore:<check name> comment to the job description.
There is already a known issue in the initial version 0.1.0 , Workspace Cleanup Plugin is a required dependency otherwise JenkinsLint will fail when analyzing those Jobs
Console OutputJul 13, 2015 10:21:06 PM hudson.ExpressionFactory2$JexlExpression evaluate WARNING: Caught exception evaluating: it.data in /jenkinslint/. Reason: java.lang.reflect.InvocationTargetException java.lang.reflect.InvocationTargetException at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:483) .... Giant Stacktrack .... at winstone.BoundedExecutorService$1.run(BoundedExecutorService.java:77) at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142) at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617) at java.lang.Thread.run(Thread.java:745) Caused by: java.lang.NoClassDefFoundError: hudson/plugins/ws_cleanup/WsCleanup$DescriptorImpl at org.jenkins.ci.plugins.jenkinslint.check.CleanupWorkspaceChecker.executeCheck(CleanupWorkspaceChecker.java:22 ) at org.jenkins.ci.plugins.jenkinslint.JenkinsLintAction.getData(JenkinsLintAction.java:60) ... 112 moreThere are two workarounds:
Installing Workspace Cleanup Plugin Upgrading the JenkinsLint versionRequirementsJenkinsJenkins version 1.554.1 or newer is required.