jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-05-29 23:07:52 +02:00
Code Issues Releases Activity
sap-jenkins-library/documentation/docs/steps/pipelineExecute.md
Christopher Fenner f757a0e1d4
fix Markdown issues (#365) 
* fix Markdown issue 'Headers should be surrounded by blank lines'

* fix MD012

* fix MD022

* fix MD026

* fix MD007

* fix MD032

* fix MD038

* fix MD040

* fix MD031

* fix MD034

* fix MD004

* fix new findings

* fix MD036

* fix MD038

* fix MD032

* fix MD006
2018-11-06 13:50:09 +01:00

1.5 KiB
Raw Blame History

pipelineExecute

Description

Loads a pipeline from a git repository. The idea is to set up a pipeline job in Jenkins that loads a minimal pipeline, which in turn loads the shared library and then uses this step to load the actual pipeline.

A centrally maintained pipeline script (Jenkinsfile) can be re-used by several projects using pipelineExecute as outlined in the example below.

Prerequisites

none

Parameters

parameter mandatory default possible values
repoUrl yes
branch no 'master'
path no 'Jenkinsfile'
credentialsId no An empty String
  • repoUrl The url to the git repository of the pipeline to be loaded.
  • branch The branch of the git repository from which the pipeline should be checked out.
  • path The path to the Jenkinsfile, inside the repository, to be loaded.
  • credentialsId The Jenkins credentials containing user and password needed to access a private git repository.

Step configuration

none

Return value

none

Side effects

none

Exceptions

  • Exception
    • If repoUrl is not provided.

Example

pipelineExecute repoUrl: "https://github.com/MyOrg/MyPipelineRepo.git", branch: 'feature1', path: 'path/to/Jenkinsfile', credentialsId: 'MY_REPO_CREDENTIALS'