Skip to content
Lint Jenkins' Jenkinsfile via SSH
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
Default (Linux).sublime-keymap
Default (OSX).sublime-keymap
Default (Windows).sublime-keymap
Default.sublime-commands
Jenkinsfile.py
Jenkinsfile.sublime-project
Jenkinsfile.sublime-settings
LICENSE
Main.sublime-menu
README.md
package-control.cleanup

README.md

sublime-Jenkinsfile

Jenkinsfile is a plugin for Sublime Text.

  • Securely (ssh) lint your Jenkinsfile (What is a Jenkinsfile?) inside of Sublime Text
  • Lint against Jenkins cloud instance if ssh access is unavailble on your primary environment
  • Magic

Jenkins includes Pipeline Development Tools as shown on Jenkins.io...

Jenkins can validate, or "lint", a Declarative Pipeline from the command line before actually running it. This can be done using a Jenkins CLI command or by making an HTTP POST request with appropriate parameters. We recommended using the SSH interface to run the linter. See the Jenkins CLI documentation for details on how to properly configure Jenkins for secure command-line access.

Technology

Jenkinsfile uses a number of open source projects to work properly:

  • Python - a programming language changes the world
  • SSH - a cryptographic network protocol for operating network services securely over an unsecured network

And of course Jenkinsfile itself is open source with a public Git repository on GitHub.

How to install

With Package Control:

  1. First step is done with Package Control or manually
    • With Package Control Run “Package Control: Install Package” command, find and install Jenkinsfile plugin.

    • Manually (without Package Control): Clone or download from git into your packages folder (in ST, find Browse Packages… menu item to open this folder). note: You must clone or download into a directory named "Jenkinsfile" and not sublime-Jenkinsfile.

  2. Restart Sublime Text (if required)

Setup

Currently you must use Pageant (Windows) to create a session that can authenticate via ssh to your Jenkins host. The name of the session must match the configured value of pageant_session (default is "jenkins") as shown:

Usage

Now whenever you have are editing a Jenkinsfile (must be named as such) and save the file, the plugin will invoke the remote instance of the Jenkins declarative-linter. The file can also be linted without saving by using the keyboard shortcut (cntl-alt-j by default)

Todos

  • Pipeline the whole enchelada (CT/CI/CD)
    • JENKINS!
    • Docker
  • Add support for Linux, OSX
  • Add hosted Jenkins validation

License

MIT

.

You can’t perform that action at this time.