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.
See JenkinsLint Plugin for more information.
Jenkins is an awesome Automation System, and there are a bunch of people using it in different ways, for instances: 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 jenkinslint plugin attempts to solve this problem by allowing jobs and slaves 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 and slaves 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 analysing them.
- Load checks dynamically via Reflection
- Enable/Configure severity
- Load checks dynamically.
- Cyclomatic complexity check when using conditional steps plugin and pipelines
- Fix Findbugs/Checkstyle defects
- Integrate with Sonar or any other Linting defects tool
List available Checks
- Artifact Publisher check
- BFA check
- Build timeout check
- CleanUp Workspace check
- Git Shallow clone check
- Git Ref repo check
- Git Ref Submodule repo check
- Gradle Wrapper check
- Groovy System Exit check
- Groovy Sandbox check
- Hardcoded Script check
- Javadoc Publisher check
- Job Assigned Label check
- Job Description check
- Job Log Rotator check
- Job Name check
- Master Assigned Label check
- Maven Job Type check
- Multibranch Job Type check
- Null SCM check
- Polling SCM Trigger check
- System.exit in system admin groovy scripts
- TimerTrigger 'Hash' check
- Slave description check
- Slave label check
- Slave version check
- Windows slave launch check
Start the local Jenkins instance:
How to install
mvn clean package
to create the plugin .hpi file.
copy the resulting ./target/jenkinslint.hpi file to the $JENKINS_HOME/plugins directory. Don't forget to restart Jenkins afterwards.
or use the plugin management console (http://example.com:8080/pluginManager/advanced) to upload the hpi file. You have to restart Jenkins in order to find the plugin in the installed plugins list.
mvn release:prepare release:perform
The MIT License Copyright (c) 2015, Victor Martinez Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.