https://github.com/aissa-laribi/jklint
A Jenkinsfile linter CLI saving time linting Jenkinsfiles by only typing 1 argument in the command line.
https://github.com/aissa-laribi/jklint
jenkins jenkinsfile linter maskedinput
Last synced: about 1 month ago
JSON representation
A Jenkinsfile linter CLI saving time linting Jenkinsfiles by only typing 1 argument in the command line.
- Host: GitHub
- URL: https://github.com/aissa-laribi/jklint
- Owner: aissa-laribi
- License: mit
- Created: 2022-11-12T00:40:33.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-15T09:57:56.000Z (over 3 years ago)
- Last Synced: 2024-06-08T00:36:22.096Z (about 2 years ago)
- Topics: jenkins, jenkinsfile, linter, maskedinput
- Language: Python
- Homepage: https://pypi.org/project/jklint/
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jklint
A Jenkinsfile linter CLI saving time linting Jenkinsfiles by only typing 1 argument in the command line.
## Features ⭐
1.Credentials entered one time only
2.Short commands to type
3.Validate Jenkinsfiles through the Jenkins Client of your server
4.Masked credentials
## Setup 🛠
Jklint can be installed through Pypi or a clone of the repository.
## From Pypi
The easiest option to setup Jklint is to install the pip package and run it into a virtual environment.
### 1.Create a virtual environment
```
python3 -m venv
```
### 2.Activate the virtual environment
Platform
Shell
Command to activate virtual environment
POSIX
bash/zsh
$ source <venv>/bin/activate
fish
$ source <venv>/bin/activate.fish
csh/tcsh
$ source <venv>/bin/activate.csh
PowerShell
$ <venv>/bin/Activate.ps1
Windows
cmd.exe
C:\> <venv>\Scripts\activate.bat
PowerShell
PS C:\> <venv>\Scripts\Activate.ps1
### 3.Install the package
```
python3 pip install jklint
```
## Through clone
### 1.Clone the repository
```
git clone https://github.com/aissa-laribi/jklint
```
### 2.Create a virtual environment
```
python3 -m venv
```
### 3.Activate the virtual environment
Platform
Shell
Command to activate virtual environment
POSIX
bash/zsh
$ source <venv>/bin/activate
fish
$ source <venv>/bin/activate.fish
csh/tcsh
$ source <venv>/bin/activate.csh
PowerShell
$ <venv>/bin/Activate.ps1
Windows
cmd.exe
C:\> <venv>\Scripts\activate.bat
PowerShell
PS C:\> <venv>\Scripts\Activate.ps1
### 4.Install dependancies and package locally
```
pip install -e .
```
## Usage
It's recommended to run jklint from a virtual environment, this way the credentials and the Jenkins client will not be found in the repository. Only the Jenkinsfile should be in the repository.
1.Configure jklint
```
jklint config
```
If you work with VS Code and your OS is a POSIX OS, an .env file should open. Otherwise, find the .env file in your current directory(that should your virtual environment directory)
Replace the values with yours and save the file.
2.Validate the file
```
jklint go
```
It will download the Jenkins client from your Jenkins url. Then, it will proceed to the validation of the Jenkinsfile
If the credentials and the syntax of the Jenkinsfile are correct it should return:
```
Jenkins-client found
CompletedProcess(args=['java', '-jar', 'jenkins-cli.jar', '-s', 'jenkins-url', '-webSocket', '-auth', 'user', 'declarative-linter'], returncode=0, stdout='Jenkinsfile successfully validated.\n', stderr='')
```
And your 'user' and 'jenkins-url' details will stay hidden.