jenkinz

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 13 Open GitHub ↗

JenkinZero (jenkinz) is a zero configuration Jenkinsfile validation tool.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![jenkinz](https://raw.githubusercontent.com/tomwillfixit/jenkinz/master/img/logo.png)

## What is JenkinZero ?

It's a zero configuration jenkins master and build agent running using "Docker in Docker".  This code is based on the work of Maxfield Stewart from Riot Games : https://github.com/maxfields2000/dockerjenkins_tutorial and was written in my free time.  Feel free to fork it, submit PRs etc.

## How do I use JenkinZero ?

It's simple to use but has some strict requirements.

1 : You must have docker and docker-compose installed.

2 : The build steps inside the Jenkinsfile provided must be 100% containerized.

3 : Currently only runs on a linux host.  Windows (cygwin) support may happen in future.

### Usage

Step 1 :
```
Check out this repository and check out your own repository (which includes your Jenkinsfile) into this repository.

If your repository is called "my_app" then the directory structure should look like :

jenkinz/my_app

For convenience there is a repository called "demo" which contains a working CI pipeline.
```

Step 2 :

Source the ./jenkinz.sh script.

```
. ./jenkinz.sh

source ./jenkinz.sh
```

This will make the jenkinz commands available in your shell.

Run : jenkinz usage

Step 3 :

Let's run some builds.  Build logs are stored in the build-logs directory and an example log can be found [here](build-logs/example.build.log).

Run a single build (uses default Jenkinsfile in top level of the demo repository) :
```
jenkinz --repository demo

```

Run a single build using a Jenkinsfile with a different name :
```
jenkinz --repository demo -f Jenkinsfile.build_only

```

Run 5 builds using a Jenkinsfile with a different name :
```
jenkinz --repository demo -f Jenkinsfile.build_only -b 5

```

Run 5 builds (uses default Jenkinsfile in top level of the demo repository) :
```
jenkinz --repository demo -b 5

```

Run a "quickcheck" build to ensure the master and agent start correctly and the pipeline project is created : 
```
jenkinz -r demo -f Jenkinsfile.quickcheck
```

Chaos (Experimental) :

The following command will use the default chaos.cb file to simulate a Jenkins Master restart and a network flap.
```
jenkinz -r demo -b 5 --chaos

```

Run builds against a specific version of Jenkins (Only supports Alpine based images)

Get a list of available Alpine based images in Docker Hub :
```
jenkinz list-tags

Example Output :

jenkinsci/jenkins:2.121-alpine
jenkinsci/jenkins:2.107.3-alpine
jenkinsci/jenkins:2.120-alpine
jenkinsci/jenkins:2.119-alpine
jenkinsci/jenkins:2.118-alpine
jenkinsci/jenkins:2.117-alpine

Run a build against a specific version :

jenkinz --image jenkinsci/jenkins:2.107.3-alpine --repository demo

```

Run a build using a specific plugin version and specific version of Jenkins

Firstly, update the version of plugin you want to use in the [plugins.list](config/plugins.list) file.
Secondly, specify the version of jenkins using the --image option.

For example :
```
jenkinz --image jenkinsci/jenkins:2.107.3-alpine --repository demo
```

## Cleanup

Stop jenkinz :
```
jenkinz stop
```

Remove jenkinz :
```
jenkinz clean
```

## Summary

The majority of this code was taken from other repositories and glued together with some bash.  Feel free
to submit PRs or fork if you find this useful.

jenkinz

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README