A helper tool to lint a Declarative Jenkinsfile
This tool helps to lint a Declarative Jenkinsfile.
The official document provides a ssh approach and a curl approach to lint a Declarative Jenkinsfile. However, both approaches are a bit complicated for daily use.
So I created this tool to lint easily. This tool itself does not lint a Jenkinsfile, but sends a request to Jenkins in the same way as curl approach and displays the result.
$ npm install jflint -g
$ jflint [options] /path/to/Jenkinsfile
Specify the URL of Jenkins to lint Jenkinsfile. The URL must be passed by this option or a config file.
Specify username for Jenkins. Username is required when security is enabled on Jenkins.
Specify password or API token for Jenkins. Password or API token is required when security is enabled on Jenkins.
Specify this options when CSRF security setting is disabled on Jenkins.
Specify a path to config file.
Disable SSL verification.
You can load options from json file like the following.
Config file is searched in the following order.
- the path specified by
.jflintrcfrom the current directory all the way up to the filesystem root
If the same setting is specified in both option and config file, the option setting overrides the config setting.
- Create a feature branch
- Commit your changes
- Rebase your local changes against the master branch
- Create new Pull Request