mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-04-07 07:10:18 +02:00
Co-authored-by: Ralf Pannemans <ralf.pannemans@sap.com> Co-authored-by: Philipp Stehle <philipp.stehle@sap.com> Co-authored-by: Pavel Busko <pavel.busko@sap.com> Co-authored-by: Jan von Löwenstein <jan.von.loewenstein@sap.com>
2.0 KiB
2.0 KiB
${docGenStepName}
${docGenDescription}
see Examples
Prerequisites
When pushing to a container registry, you need to maintain the respective credentials in your Jenkins credentials store:
cnbBuild
expects a Docker config.json
file containing the credential information for registries.
You can create it like explained in the protocodeExecuteScan Prerequisites section.
Please copy this file and upload it to your Jenkins for example
via Jenkins -> Credentials -> System -> Global credentials (unrestricted) -> Add Credentials ->
- Kind: Secret file
- File: upload your
config.json
file - ID: specify id which you then use for the configuration of
dockerConfigJsonCredentialsId
(see below)
${docGenParameters}
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.
${docGenConfiguration}
${docJenkinsPluginDependencies}
Examples
Example 1: simple usage
cnbBuild(
script: script,
dockerConfigJsonCredentialsId: 'DOCKER_REGISTRY_CREDS',
containerImageName: 'images/example',
containerImageTag: 'v0.0.1',
containerImageRegistryUrl: 'gcr.io'
)
Example 2: User provided builder
cnbBuild(
script: script,
dockerConfigJsonCredentialsId: 'DOCKER_REGISTRY_CREDS',
dockerImage: 'paketobuildpacks/builder:base',
containerImageName: 'images/example',
containerImageTag: 'v0.0.1',
containerImageRegistryUrl: 'gcr.io'
)
Example 3: User provided buildpacks
cnbBuild(
script: script,
dockerConfigJsonCredentialsId: 'DOCKER_REGISTRY_CREDS',
containerImageName: 'images/example',
containerImageTag: 'v0.0.1',
containerImageRegistryUrl: 'gcr.io',
buildpacks: ['gcr.io/paketo-buildpacks/nodejs', 'paketo-community/build-plan']
)