jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-11-29 22:58:09 +02:00
Code Issues Releases Activity

cnbBuild documentation for custom builders (#3077)

Browse Source 
* Docs for user provided builder images

Co-authored-by: Benjamin Haegenlaeuer <benjamin.haegenlaeuer@sap.com>

* check if provided dockerImage is a valid builder

Co-authored-by: Pavel Busko <pavel.busko@sap.com>

Co-authored-by: Benjamin Haegenlaeuer <benjamin.haegenlaeuer@sap.com>
This commit is contained in:
Pavel Busko
2021-09-14 15:38:58 +02:00
committed by GitHub
parent b7170053e3
commit 0271ef51c4
4 changed files with 96 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
documentation/docs/steps/cnbBuild.md
View File

@@ -2,8 +2,38 @@
## ${docGenDescription}
### Additional hints
To run the `cnbBuild` with a different builder, you can specify the `dockerImage` parameter.
Without specifying it, the step will run with the `paketobuildpacks/builder:full` builder.
## ${docGenParameters}
## ${docGenConfiguration}
## ${docJenkinsPluginDependencies}
## Example 1
```groovy
cnbBuild(
script: script,
dockerConfigJsonCredentialsId: 'DOCKER_REGISTRY_CREDS',
containerImageName: 'images/example',
containerImageTag: 'v0.0.1',
containerImageRegistryUrl: 'gcr.io'
)
```
## Example 2: User provided builder
```groovy
cnbBuild(
script: script,
dockerConfigJsonCredentialsId: 'DOCKER_REGISTRY_CREDS',
dockerImage: 'paketobuildpacks/builder:base',
containerImageName: 'images/example',
containerImageTag: 'v0.0.1',
containerImageRegistryUrl: 'gcr.io'
)
```