Skip to content

tracetronic/jenkins-library

Repository files navigation

Jenkins Library

This repository consists of a Jenkins shared library to extend Jenkins pipelines in order to share common parts between various projects and to reduce redundancies and keep code "DRY".

Jenkins Library project is part of the Automotive DevOps Platform by tracetronic. With the Automotive DevOps Platform, we go from the big picture to the details and unite all phases of vehicle software testing – from planning the test scopes to summarizing the test results. At the same time, continuous monitoring across all test phases always provides an overview of all activities – even with several thousand test executions per day and in different test environments.

Table of Content

Project Structure

This repository is based on the predefined directory structure of Jenkins shared libraries.

Dependencies

To simplify maintenance and to avoid duplicate implementations, some vars utilize features from other Jenkins plugins.

Global Vars Prerequisites
maven Local Maven installation or configured in Jenkins (Global Tool Configuration)
log ANSI Color Plugin
pipeline2ATX Pipeline Utility Steps Plugin, Pipeline: Stage View

For more information open /pipeline-syntax/globals on your Jenkins instance or see the help files in the vars folder.

Usage

Use Cases

Each global variable is designed to cover specific requirements. The description of such use cases and requirements can be found in the vars directory next to the implementation. For a higher level description have a look at our Automotive DevOps Platform.

Technical Usage

There are several ways to include this shared library within your own environment:

  • Global Shared Libaries
  • Folder-level Shared Libraries
  • Automatic Shared Libraries

For further information and a deeper insight into usage, dynamic loading or versioning, please read Extending with Shared Libraries and Pipeline: Shared Groovy Libraries.

Documentation

A complete documentation of all classes and methods can be reached at GitHub Pages.

Contribution

We encourage you to contribute to Jenkins Library using the issue tracker to suggest feature requests and report bugs.

Currently, we do not accept any external pull requests.

Support

If you have any questions, please contact us at [email protected].

License

This project is licensed under the terms of the MIT license.

Using the REUSE helper tool, you can run reuse spdx to get a bill of materials.