Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/v1v/jenkins-pipeline-library-skeleton
Jenkins shared library using the Everything as Code practice
https://github.com/v1v/jenkins-pipeline-library-skeleton
jcasc jenkinsci pipeline pipeline-framework
Last synced: about 2 months ago
JSON representation
Jenkins shared library using the Everything as Code practice
- Host: GitHub
- URL: https://github.com/v1v/jenkins-pipeline-library-skeleton
- Owner: v1v
- License: mit
- Created: 2019-12-14T15:46:27.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-26T16:19:37.000Z (about 4 years ago)
- Last Synced: 2024-10-14T07:42:28.354Z (3 months ago)
- Topics: jcasc, jenkinsci, pipeline, pipeline-framework
- Language: Groovy
- Size: 70.3 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shared library
A shared library with some vitamins to help you to speed up your local development.
## Context
This is an example of a shared library for the Jenkins pipelines based on:
- [JCasC](https://jenkins.io/projects/jcasc/) to configure a local jenkins instance.
- [JobDSL](https://github.com/jenkinsci/job-dsl-plugin/wiki) to configure the pipelines to test the steps.
- [JenkinsUnitPipeline](https://github.com/jenkinsci/JenkinsPipelineUnit) to test the shared library steps.
- [Spock](http://spockframework.org/spock/docs/1.0/introduction.html) to test the shared library steps with some specifications approach.
- [Gradle](https://docs.gradle.org/current/userguide/userguide.html) to orchestrate the build/tests of this library.
- [Vagrant](https://www.vagrantup.com/docs/index.html) and [VirtualBox](https://www.virtualbox.org/wiki/Documentation) to spin up jenkins agents using the Swarm connection.
## System Requirements
- Docker >= 19.x.x
- Docker Compose >= 1.25.0
- Vagrant >= 2.2.4
- VirtualBox >= 6
- Java >= 8
## Layout
```
(root)
+- src # Groovy source files
| +- org
| +- v1v
| +- Bar.groovy # for org.v1v.Bar class
| +- test
| +- groovy
| +- FooStepTest.groovy # Tests for the foo step
+- vars
| +- foo.groovy # for global 'foo' variable
| +- foo.txt # help for 'foo' variable
+- resources # resource files (external libraries only)
| +- org
| +- v1v
| +- bar.json # static helper data for org.foo.Bar
+- local # to enable a jenkins instance with this library
| +- configs
| +- jenkins.yaml
| +- plugins.txt
| +- workers
| +- linux
| +- Vagrantfile
| +- docker-compose.yml
| +- Dockerfile
|
```
## How to test it
```bash
./gradlew clean test
open build/reports/tests/test/index.html
```
### How to test it within the local Jenkins instance
1. Build docker image by running:
```
make -C local build
```
2. Start the local Jenkins master service by running:
```
make -C local start
```
3. Browse to in your web browser.
#### Enable the local agent
```bash
make -C local start-local-worker
```
#### Enable the linux vagrant worker
```bash
make -C local start-linux-worker
```
#### Customise what plugins are installed
You can configure this jenkins instance as you wish, if so please change:
* local/configs/jenkins.yaml using the [JCasC](https://jenkins.io/projects/jcasc/)
* local/configs/plugins.txt
## What's next?
- Be able to programmatically run functional tests.