Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/colinbut/jenkins-shared-library
My personal Jenkins Shared Library
https://github.com/colinbut/jenkins-shared-library
groovy groovy-code groovy-language groovy-script groovy-scripts jenkins jenkins-ci jenkins-pipeline jenkins-shared-library jenkinsfile pipeline pipelines pipelines-as-code
Last synced: about 1 month ago
JSON representation
My personal Jenkins Shared Library
- Host: GitHub
- URL: https://github.com/colinbut/jenkins-shared-library
- Owner: colinbut
- License: unlicense
- Created: 2020-04-26T17:25:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-15T19:06:39.000Z (over 1 year ago)
- Last Synced: 2024-09-30T18:01:21.680Z (about 1 month ago)
- Topics: groovy, groovy-code, groovy-language, groovy-script, groovy-scripts, jenkins, jenkins-ci, jenkins-pipeline, jenkins-shared-library, jenkinsfile, pipeline, pipelines, pipelines-as-code
- Language: Groovy
- Homepage:
- Size: 57.6 KB
- Stars: 36
- Watchers: 2
- Forks: 31
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jenkins Shared Library
[](https://circleci.com/gh/colinbut/jenkins-shared-library)
This is my personal Jenkins Shared Library.
This repository contains a library of Jenkins Global Variables & Helper Variables that I can use in my project's `Jenkinsfile`
Based on the following articles:
- [How-To-Build-Your-Own-Jenkins-Shared-Library](https://itnext.io/how-to-build-your-own-jenkins-shared-library-9dc129db260c)
- [Unit-Testing-A-Jenkins-Shared-Library](https://itnext.io/unit-testing-a-jenkins-shared-library-9bfb6b599748)
## Usage
### Import Library
As per the instructions on the [Jenkins Documentation], to include this library; in your `Jenkinsfile`:
```groovy
@Library('[email protected]') _
```
note that the name is the `id` of the Shared Library configured under Jenkins Configuration and the version after the `@` sign
can be `master` which points to the master branch of this library or simply omitted which would pick up the
default version configured under Jenkins Configuration (if you have it configured there).
### Using Global Variables
To use one of the global variables or helper variables defined in this library you just simply call it like the following examples.
```groovy
@Library('[email protected]') _
buildJavaApp(repo: "name of repo")
```
```groovy
@Library('[email protected]') _
buildJavaAppDockerFull(repo: "name of repo", microserviceName: "example-app")
```
See under `vars/` to see list of full available Global Variables/Helper Variables to use.
Alternatively, you can check out this example demo project which shows some use cases of this Shared Library:
[Jenkins Pipelines](http://github.com/colinbut/jenkins-pipelines.git)
### Configuration
A lot of the configuration for external systems (Github, SonarQube etc) are set in the `Constants.groovy` constants class.
You can edit this to match according to your settings.
### Global Vars Documentation
Each of the global variables (helper functions) has its own documentation (corresponding *.txt file). You can access these documentation on the __Global Variable Reference__ link on the navigation sidebar of pipeline jobs that imported this shared library.
Note that as per Jenkins documentation this is only visible after one successful run of the pipeline job for the documentation to be generated.
The documentation is in (.txt) file format and contains HTML.
## Author
Colin But
## Release Notes
__v0.0.2__
+ global variables documentation
+ new log levels (fatal, trace) to log utility
+ support for sonar in pipeline jobs
__v0.0.1__
+ basic Global Variables (steps) to build:
+ a Java App
+ a full pipeline of building a Java App (from checkout to deployment)
+ Library classes to:
+ build Docker Image
+ Push Docker Image to AWS ECR (Elastic Container Registry) - AWS's Docker Registry
+ basic Git helper commands
+ utilities
+ logging
+ notifications
+ Unit Tests using Jenkins-Spock