Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dontshavetheyak/jenkins-std-lib

Bringing the Zen of Python to Jenkins.
https://github.com/dontshavetheyak/jenkins-std-lib

cicd jenkins shared-library

Last synced: about 2 months ago
JSON representation

Bringing the Zen of Python to Jenkins.

Awesome Lists containing this project

README 

        

[![Tests][test-badge]][test-url]

[![Lint][lint-badge]][test-url]

[![Latest][doc-badge]][doc-url]



[DontShaveTheYak](https://github.com/DontShaveTheYak) presents the Jenkins Standard Library. A set of useful tools for every day CI/CD jobs.



Why use our library?

* Portable! This library requires very few [plugins](./docker/prod/plugins.txt).

* OpenSource and [Free to use](https://choosealicense.com/licenses/gpl-3.0/)

* We fully [test][test-url] and [lint][test-url] this codebase.

* Our [Releases][releases-url] and [Docs][doc-url] are automated.

* [Less Yak Shaving](https://seths.blog/2005/03/dont_shave_that/) for your team.



[![Jenkins](https://cdn.freebiesupply.com/logos/large/2x/jenkins-logo-png-transparent.png)](https://www.jenkins.io/)



## Demo



Do you want to see the features first? We have a docker image that has Jenkins already setup, configured with our library and some sample jobs.



```sh

docker run -d --rm -p 4000:80 dsty/jenkins:demo

```



You can then see the jenkins at [127.0.0.1:4000](http://127.0.0.1:4000). If the seed job hasn't run, you can run it manually.



## Installation



First you need to configure your Jenkins with our Shared Library. In the Jenkins configure page scroll down

until you reach "Global Pipeline Libraries". This is where you can configure what you want to name the library, which version

to use, and the url to reach it.



![Configure](.images/configure.PNG)



*Note: Default version of master will get you the latest release. For production you should pin Default version to a [release][releases-url] tag.*



For more detailed information see the offical Jenkins [Shared Library](https://www.jenkins.io/doc/book/pipeline/shared-libraries/) documentation.



### Recommended Setup



Our Shared Library will function and look its best if you setup the additional plugins below. We currently only support Agents that use Linux.



We recommend the following plugins:

* [simple-theme-plugin](https://plugins.jenkins.io/simple-theme-plugin/) - To remove non-useful information from build console. Use this config:



  ```

  .pipeline-annotated {

     display: none;

  }

  .pipeline-new-node {

        display: none;

  }

  ```

* [AnsiColor](https://plugins.jenkins.io/ansicolor/) - To get color coded log messages from our logging package.



The required plugins enable complete library functionality can be found in [plugins.txt](./docker/prod/plugins.txt).



*Note: Individual library functions may have their own requirements. See the [docs][doc-url]*



### Usage



Once you have installed our shared library you just need to reference it at the top of any jobs.

```

@Library('jenkins-std-lib')

```



For full javadoc documentation see [here][doc-url]. To see example Jenkinsfile's check out the [job](./jobs) directory.



## Support DTSY



I'm just a DevOps engineer trying to make the kind of tools I would like to see at work.



You can support my efforts in any of the following ways:

* Star this repo! :star_struck:

* Follow me on [Twitter](https://twitter.com/DontShaveTheYak).

* Spread the word :grin:

* Contribute to this repo using the [guide](./CONTRIBUTING.md)!

* Sponsor me on [GitHub](https://github.com/sponsors/shadycuz) :heart_eyes:

* Support me on [Patreon](https://www.patreon.com/DontShaveTheYak) :smiling_face_with_three_hearts:

## License

This project is licensed as `GNU General Public License v3.0` see [LICENSE.md](LICENSE.md).



License [attribution](https://app.fossa.com/reports/86d307a0-2efa-4fd9-b983-3fd9382433e0) for depenencies.



[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B25932%2Fgithub.com%2FDontShaveTheYak%2Fjenkins-std-lib.svg?type=large)](https://app.fossa.com/projects/custom%2B25932%2Fgithub.com%2FDontShaveTheYak%2Fjenkins-std-lib?ref=badge_large)



[test-badge]: https://img.shields.io/github/actions/workflow/status/DontShaveTheYak/jenkins-std-lib/test.yml?label=Tests

[lint-badge]: https://img.shields.io/github/actions/workflow/status/DontShaveTheYak/jenkins-std-lib/test.yml?label=Lint

[test-url]: https://github.com/DontShaveTheYak/jenkins-std-lib/actions/workflows/test.yml

[doc-badge]: https://javadoc.io/badge2/io.github.dontshavetheyak/jenkins-std-lib/javadoc.svg?cacheSeconds=3600

[doc-url]: https://javadoc.io/doc/io.github.dontshavetheyak/jenkins-std-lib

[releases-url]: https://github.com/DontShaveTheYak/jenkins-std-lib/releases