jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00
Code Issues Releases Activity
Jenkins shared library for Continuous Delivery pipelines.
1,718 Commits 354 Branches 457 Tags 1.5 GiB
Go 76.1%
Groovy 23.8%
de539cc677
Go to file
Marcus Holl de539cc677 fetch possible values from @see 
In case there is a @see tag provided for a parameter in the description,
the possible values are only fetched from the corresponding source in
case there is no explict value provided for the possible values.

In case the source does not contain a possible value tag nothing is
transfered.
2019-04-12 14:23:35 +02:00
.github Update CONTRIBUTING.md 2019-03-15 17:48:36 +01:00
cfg Deploy mkdocs when merging to master 2018-03-12 09:58:32 +01:00
consumer-test Fix typos and small IDE hints in IT controller (#588) 2019-03-26 10:32:26 +01:00
documentation fetch possible values from @see 2019-04-12 14:23:35 +02:00
resources remove utils.getMandatoryParameter() 2019-04-09 16:25:25 +02:00
src/com/sap/piper influxWriteData: hold data in dedicated object (#624) 2019-04-11 11:39:41 +02:00
template correct step invokation in tests (#368) 2018-11-07 11:45:38 +01:00
test cloudFoundryDeploy: generate docu 2019-04-12 13:08:05 +02:00
vars cloudFoundryDeploy: generate docu 2019-04-12 13:08:05 +02:00
.codeclimate.yml New Scenario Step: SAP UI5 on SAP Cloud Platform (#388) 2019-01-15 13:32:01 +01:00
.editorconfig fix Markdown issues (#365) 2018-11-06 13:50:09 +01:00
.gitignore Create s4sdk consumer tests for neo environment (#524) 2019-02-22 13:31:50 +01:00
.travis.yml push correct docs folder (#654) 2019-04-10 13:49:40 +02:00
LICENSE Initial commit 2017-10-17 16:14:48 -04:00
NOTICE Create NOTICE 2017-11-14 09:51:35 +01:00
pom.xml bump version (#562) 2019-03-20 13:58:12 +01:00
README.md [docu] remove old reference pipelines (#594) 2019-03-27 11:42:07 +01:00

README.md

Build Status Maintainability Test Coverage

Description

An efficient software development process is vital for success in building business applications on SAP Cloud Platform or SAP on-premise platforms. SAP addresses this need for efficiency with project "Piper". The goal of project "Piper" is to substantially ease setting up continuous delivery processes for the most important SAP technologies by means of Jenkins pipelines.

Project "Piper" consists of two parts:

  • A shared library containing steps and utilities that are required by Jenkins pipelines.
  • A set of Docker images used in the piper library to implement best practices.

Please follow this link to our extended library documentation.

What you get

The shared library contains all the necessary steps to run our best practice Jenkins pipelines described in the Scenarios section or to run a pipeline as step.

The best practice pipelines are based on the general concepts of Jenkins 2.0 Pipelines as Code. With that you have the power of the Jenkins community at hand to optimize your pipelines.

You can run the best practice Jenkins pipelines out of the box, take them as a starting point for project-specific adaptations or implement your own pipelines from scratch using the shared library.

Extensibility

If you consider adding additional capabilities to your Jenkinsfile, consult the Jenkins Pipeline Steps Reference. There, you get an overview about steps that are natively supported by Jenkins.

The Jenkins shared libraries concept helps you to extract reusable parts from your pipeline and to keep your pipeline code small and easy to maintain.

Custom library steps can be added using a custom library according to the Jenkins shared libraries concept instead of adding groovy coding to the Jenkinsfile. Your custom library can coexist next to the provided pipeline library.

API

All steps (vars and resources directory) are intended to be used by Pipelines and are considered API. All the classes / groovy-scripts contained in the src folder are by default not part of the API and are subjected to change without prior notice. Types and methods annotated with @API are considered to be API, used e.g. from other shared libraries. Changes to those methods/types needs to be announced, discussed and agreed.

Requirements

  • Java Runtime Environment 8
  • Installation of Jenkins v 2.60.3 or higher running on Linux. We tested with debian-stretch.
  • Jenkins Plugins installed as described in the Required Plugin section.
  • A Jenkins user with administration privileges.
  • The Jenkins instance has access to github.com.

Download and Installation

To setup the shared library, you need to perform the following steps:

  1. Login to your Jenkins instance with administration privileges.
  2. Open the system configuration page (Manage Jenkins > Configure System).
  3. Scroll down to section Global Pipeline Libraries and add a new Library by clicking the Add button.
    1. set Library Name to piper-lib-os
    2. set Default Version to the branch or tag you want to consume (e.g. master or v0.1)
    3. set Retrieval Method to Modern SCM
    4. set Source Code Management to Git
    5. set Project Repository to https://github.com/SAP/jenkins-library
  4. Save changes

Library Setup

Now the library is available as piper-lib-os and can be used in any Jenkinsfile by adding this line:

@Library('piper-lib-os') _

Jenkins will download the library during execution of the Jenkinsfile.

Known Issues

A list of known issues is available on the GitHub issues page of this project.

How to obtain support

Feel free to open new issues for feature requests, bugs or general feedback on the GitHub issues page of this project.

Register to our google group in order to get updates or for asking questions.

Contributing

Read and understand our contribution guidelines before opening a pull request.

License

Copyright (c) 2017 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file