2019-09-19 14:17:41 +02:00
|
|
|
site_name: 'Project "Piper": Continuous Delivery for the SAP Ecosystem'
|
2018-09-25 14:03:22 +02:00
|
|
|
nav:
|
2020-07-03 10:28:48 +02:00
|
|
|
- 'Home': index.md
|
2019-12-09 16:48:36 +02:00
|
|
|
- 'Getting Started With Project "Piper"' : guidedtour.md
|
2020-07-03 10:28:48 +02:00
|
|
|
- 'Configuration': configuration.md
|
|
|
|
|
- 'Infrastructure':
|
|
|
|
|
- 'Overview': infrastructure/overview.md
|
|
|
|
|
- 'Custom Jenkins Setup': infrastructure/customjenkins.md
|
2019-09-19 14:17:41 +02:00
|
|
|
- 'Pipelines':
|
2020-07-07 10:06:15 +02:00
|
|
|
- 'ABAP Environment pipeline':
|
|
|
|
|
- 'Introduction': pipelines/abapEnvironment/introduction.md
|
|
|
|
|
- 'Configuration': pipelines/abapEnvironment/configuration.md
|
2019-09-19 14:17:41 +02:00
|
|
|
- 'General purpose pipeline':
|
|
|
|
|
- 'Introduction': stages/introduction.md
|
|
|
|
|
- 'Examples': stages/examples.md
|
|
|
|
|
- 'Stages':
|
|
|
|
|
- 'Init Stage': stages/init.md
|
|
|
|
|
- 'Pull-Request Voting Stage': stages/prvoting.md
|
|
|
|
|
- 'Build Stage': stages/build.md
|
|
|
|
|
- 'Additional Unit Test Stage': stages/additionalunittests.md
|
|
|
|
|
- 'Integration Stage': stages/integration.md
|
|
|
|
|
- 'Acceptance Stage': stages/acceptance.md
|
|
|
|
|
- 'Security Stage': stages/security.md
|
|
|
|
|
- 'Performance Stage': stages/performance.md
|
|
|
|
|
- 'Compliance': stages/compliance.md
|
|
|
|
|
- 'Confirm Stage': stages/confirm.md
|
|
|
|
|
- 'Promote Stage': stages/promote.md
|
|
|
|
|
- 'Release Stage': stages/release.md
|
2020-02-18 18:51:44 +02:00
|
|
|
- 'SAP Cloud SDK pipeline':
|
|
|
|
|
- 'Introduction': pipelines/cloud-sdk/introduction.md
|
2020-09-08 13:53:06 +02:00
|
|
|
- 'Configuration': pipelines/cloud-sdk/configuration.md
|
2020-09-11 11:47:03 +02:00
|
|
|
- 'Stages':
|
|
|
|
|
- 'Build and Test': stages/build.md
|
|
|
|
|
- 'Additional Unit Tests': stages/additionalunittests.md
|
|
|
|
|
- 'Integration Tests': stages/integration.md
|
|
|
|
|
- 'End to End Tests': stages/acceptance.md
|
|
|
|
|
- 'Security': stages/security.md
|
2020-09-15 09:38:10 +02:00
|
|
|
- 'Compliance': stages/compliance.md
|
2020-09-11 11:47:03 +02:00
|
|
|
- 'Performance': stages/performance.md
|
|
|
|
|
- 'Production Deployment': stages/release.md
|
2020-02-18 18:51:44 +02:00
|
|
|
- 'Build Tools': pipelines/cloud-sdk/build-tools.md
|
|
|
|
|
- 'Cloud Qualities': pipelines/cloud-sdk/cloud-qualities.md
|
2019-09-19 14:17:41 +02:00
|
|
|
- 'Scenarios':
|
2020-10-19 09:21:14 +02:00
|
|
|
- 'Build and Deploy Hybrid Applications with SAP Solution Manager': scenarios/changeManagement.md
|
|
|
|
|
- 'Build and Deploy SAPUI5/SAP Fiori Applications on SAP Cloud Platform': scenarios/ui5-sap-cp/Readme.md
|
|
|
|
|
- 'Build and Deploy SAP Cloud Application Programming Model Applications': scenarios/CAP_Scenario.md
|
2019-09-19 14:17:41 +02:00
|
|
|
- 'Integrate SAP Cloud Platform Transport Management Into Your CI/CD Pipeline': scenarios/TMS_Extension.md
|
2020-10-19 09:21:14 +02:00
|
|
|
- 'Build and Deploy SAP Fiori Applications on SAP HANA Extended Application Services, Advanced Model': scenarios/xsa-deploy/Readme.md
|
|
|
|
|
- 'Build an SAP Fiori Application and Attach It to a Transport Request on an ABAP System': scenarios/upload-to-transportrequest/Readme.md
|
2020-10-19 18:16:54 +02:00
|
|
|
- 'Build and Publish Add-on Products on SAP Cloud Platform ABAP Environment': scenarios/abapEnvironmentAddons.md
|
2019-07-03 10:13:26 +02:00
|
|
|
- Extensibility: extensibility.md
|
2017-07-11 15:12:03 +02:00
|
|
|
- 'Library steps':
|
2020-09-17 11:01:19 +02:00
|
|
|
- abapAddonAssemblyKitCheckCVs: steps/abapAddonAssemblyKitCheckCVs.md
|
2020-09-17 15:56:14 +02:00
|
|
|
- abapAddonAssemblyKitCheckCVs: steps/abapAddonAssemblyKitCheckPV.md
|
2020-09-18 11:18:51 +02:00
|
|
|
- abapAddonAssemblyKitCreateTargetVector: steps/abapAddonAssemblyKitCreateTargetVector.md
|
2020-09-18 10:24:46 +02:00
|
|
|
- abapAddonAssemblyKitPublishTargetVector: steps/abapAddonAssemblyKitPublishTargetVector.md
|
2020-09-18 14:07:42 +02:00
|
|
|
- abapAddonAssemblyKitRegisterPackages: steps/abapAddonAssemblyKitRegisterPackages.md
|
2020-09-18 16:40:49 +02:00
|
|
|
- abapAddonAssemblyKitReleasePackages: steps/abapAddonAssemblyKitReleasePackages.md
|
2020-09-18 17:27:04 +02:00
|
|
|
- abapAddonAssemblyKitReserveNextPackages: steps/abapAddonAssemblyKitReserveNextPackages.md
|
2020-08-27 07:54:03 +02:00
|
|
|
- abapEnvironmentAssemblePackages: steps/abapEnvironmentAssemblePackages.md
|
2020-08-06 09:59:55 +02:00
|
|
|
- abapEnvironmentCheckoutBranch: steps/abapEnvironmentCheckoutBranch.md
|
2020-08-26 09:52:50 +02:00
|
|
|
- abapEnvironmentCloneGitRepo: steps/abapEnvironmentCloneGitRepo.md
|
2019-11-07 16:40:45 +02:00
|
|
|
- abapEnvironmentPullGitRepo: steps/abapEnvironmentPullGitRepo.md
|
2020-05-14 14:48:12 +02:00
|
|
|
- abapEnvironmentRunATCCheck: steps/abapEnvironmentRunATCCheck.md
|
2020-04-08 09:28:03 +02:00
|
|
|
- artifactPrepareVersion: steps/artifactPrepareVersion.md
|
2018-08-15 11:41:01 +02:00
|
|
|
- batsExecuteTests: steps/batsExecuteTests.md
|
2019-09-25 08:55:51 +02:00
|
|
|
- buildExecute: steps/buildExecute.md
|
2018-08-06 08:57:36 +02:00
|
|
|
- checkChangeInDevelopment: steps/checkChangeInDevelopment.md
|
2020-02-12 09:53:32 +02:00
|
|
|
- checkmarxExecuteScan: steps/checkmarxExecuteScan.md
|
2018-10-17 12:05:11 +02:00
|
|
|
- checksPublishResults: steps/checksPublishResults.md
|
Variable Substitution in YAML Files (#852)
* Changes:
- New YamlSubstituteVariables step to substitute variables in YAML files with values from another YAML
- New Tests, that check the different substitution patterns.
- Added test resources, including various manifest and variables files.
- Improved usage of JenkinsLoggingRule
- Improved JenkinsReadYamlRule to properly reflect the mocked library's behaviour.
- Added a new JenkinsWriteYamlRule.
* Changes:
- added a Logger that checks a config.verbose flag before it logs debug messages.
- changed error handling to rethrow Yaml parsing exception in case of wrongly-formatted Yaml files.
- changed JenkinsWriteYamlRule to capture Yaml file details of every invocation of writeYaml. This allows sanity checks at end of tests, even if there were multiple invocations.
- adjusted tests.
* Changes:
- Removed javadoc-code blocks from API documentation since they are not supported.
- Removed skipDeletion boolean.
- Added a new deleteFile script which deletes a file if present.
- Added a new JenkinsDeleteFileRule to mock deleteFile script and optionally skip deletion for tests.
- Adjusted yamlSubstituteVariables script.
- Adjusted tests to include new JenkinsDeleteFileRule.
- Changed code that deletes an already existing output file to produce better logs.
* Changes:
- Turned yamlSubstituteVariables into a script that works purely based on Yaml data (not files).
- Added a new cfManifestSubstituteVariables that uses yamlSubstituteVariables under the hood but works based on files.
- Adjusted tests, and added new ones.
* Adjusted documentation and a few log statements.
* Changed documentation to no longer include javadoc code statements.
* Made mocking of deletion of a file a default. Adjusted tests.
* Changed signature of yamlSubstituteVariables' call method to return void.
* Changes:
- Fixed naming issues in deleteFile.
- Renamed Logger to DebugHelper.
- Fixed some documentation.
* Changed implementation of deleteFile not to use java.io.File - which is evil when using it for file operations.
* PROPERLY Changed implementation of deleteFile not to use java.io.File - which is evil when using it for file operations.
* Changes:
- Added tests for deleteFile script
- Changed JenkinsFileExistsRule to also keep track of which files have been queried for existence.
* Changes:
- Removed java.io.File usage from cfManifestSubstituteVariables and using fileExists instead now.
- Adjusted tests.
* Wrapped file path inside ticks to allow spaces in file path when calling deleteFile.
* Removed null checks of mandatory parameters, and resorted to ConfigurationHelper.withMandatoryProperty
* Fixed a NullPointer due to weird Jenkins / Groovy behaviour.
* Changes:
- Turned yamlSubstituteVariables step into a utils class.
- Added tests
- Adjusted cfManifestSubstituteVariables to use utils class instead of step.
- Adjusted tests
- Adjusted APIs of DebugHelper.
* Re-introduced log statement that shows what variables are being replaced and with what.
* Changing API of YamlUtils to take the script and config as input.
* Test
* Test
* Test
* Test
* Test
* Fixing issue.
* Fixing issue.
* Changes:
- Refactored DebugHelper and YamlUtils to make usage nicer and rely on dependency injection.
- Removed Field for DebugHelper and turned it into local variable.
- Adjusted classes using the above.
- Adjusted tests where necessary.
* Added link to CF standards to YamlUtils also.
* Add docu for step cfManifestSubstituteVariables.md
* Added documentation.
* Added missing script parameter to documentation. Some steps document it, some don't. Right now you need it, so we document it.
* Fixed some layouting and typos
* Beautified exception listing.
* Removed trailing whitespaces to make code climate checks pass.
* Trying to get documentation generated, with all the exceptions to markup one should not use.
* cosmetics.
* cosmetics, part 2
* Code climate changes...
* Inlined deleteFile step.
* Added two more tests to properly check file deletion and output handling.
* Changes:
- adjusted API to take a list of variables files, as does 'cf push --vars-file'
- adjusted API to allow for an optional list of variable key-value-maps as does 'cf push --vars'
- reproduced conflict resolution and overriding behavior of variables files and vars lists
- adjusted tests and documentation
* Added missing paramter to doc comment.
* Re-checked docs for missing paramters or params that have no counterpart in the method signature.
* Adjusted documentation.
* Removed absolute path usage from documentation.
* corrected documentation.
* Changed javadoc comment to plain comment.
* Turned all comments to plain comments.
2019-09-06 10:20:35 +02:00
|
|
|
- cfManifestSubstituteVariables: steps/cfManifestSubstituteVariables.md
|
2019-11-21 09:27:06 +02:00
|
|
|
- cloudFoundryCreateService: steps/cloudFoundryCreateService.md
|
2019-12-02 15:02:51 +02:00
|
|
|
- cloudFoundryCreateServiceKey: steps/cloudFoundryCreateServiceKey.md
|
2020-02-10 15:53:12 +02:00
|
|
|
- cloudFoundryDeleteService: steps/cloudFoundryDeleteService.md
|
2018-08-15 09:30:35 +02:00
|
|
|
- cloudFoundryDeploy: steps/cloudFoundryDeploy.md
|
2017-07-11 15:12:03 +02:00
|
|
|
- commonPipelineEnvironment: steps/commonPipelineEnvironment.md
|
2019-01-31 10:39:13 +02:00
|
|
|
- containerExecuteStructureTests: steps/containerExecuteStructureTests.md
|
2019-09-25 11:00:35 +02:00
|
|
|
- containerPushToRegistry: steps/containerPushToRegistry.md
|
2020-09-29 11:26:55 +02:00
|
|
|
- debugReportArchive: steps/debugReportArchive.md
|
2019-05-10 08:06:38 +02:00
|
|
|
- detectExecuteScan: steps/detectExecuteScan.md
|
2018-01-24 10:55:38 +02:00
|
|
|
- dockerExecute: steps/dockerExecute.md
|
2018-08-21 15:45:59 +02:00
|
|
|
- dockerExecuteOnKubernetes: steps/dockerExecuteOnKubernetes.md
|
2019-06-19 16:52:18 +02:00
|
|
|
- dubExecute: steps/dubExecute.md
|
2018-01-24 10:55:38 +02:00
|
|
|
- durationMeasure: steps/durationMeasure.md
|
2020-05-27 13:36:40 +02:00
|
|
|
- fortifyExecuteScan: steps/fortifyExecuteScan.md
|
2018-10-17 16:44:20 +02:00
|
|
|
- gaugeExecuteTests: steps/gaugeExecuteTests.md
|
2020-07-17 10:59:47 +02:00
|
|
|
- gctsCloneRepository: steps/gctsCloneRepository.md
|
|
|
|
|
- gctsCreateRepository: steps/gctsCreateRepository.md
|
|
|
|
|
- gctsDeploy: steps/gctsDeploy.md
|
|
|
|
|
- gctsExecuteABAPUnitTests: steps/gctsExecuteABAPUnitTests.md
|
2020-07-23 20:20:07 +02:00
|
|
|
- gctsRollback: steps/gctsRollback.md
|
2020-09-14 18:08:24 +02:00
|
|
|
- githubCheckBranchProtection: steps/githubCheckBranchProtection.md
|
2020-09-15 17:50:55 +02:00
|
|
|
- githubCreatePullRequest: steps/githubCreatePullRequest.md
|
2019-04-17 16:00:38 +02:00
|
|
|
- githubPublishRelease: steps/githubPublishRelease.md
|
2020-09-14 18:08:24 +02:00
|
|
|
- githubSetCommitStatus: steps/githubSetCommitStatus.md
|
2019-06-06 13:52:20 +02:00
|
|
|
- hadolintExecute: steps/hadolintExecute.md
|
2017-07-11 15:12:03 +02:00
|
|
|
- handlePipelineStepErrors: steps/handlePipelineStepErrors.md
|
2018-10-12 16:06:41 +02:00
|
|
|
- healthExecuteCheck: steps/healthExecuteCheck.md
|
2018-01-24 10:55:38 +02:00
|
|
|
- influxWriteData: steps/influxWriteData.md
|
2019-12-16 23:09:25 +02:00
|
|
|
- jenkinsMaterializeLog: steps/jenkinsMaterializeLog.md
|
2019-06-19 11:08:09 +02:00
|
|
|
- kanikoExecute: steps/kanikoExecute.md
|
2018-11-08 13:15:15 +02:00
|
|
|
- karmaExecuteTests: steps/karmaExecuteTests.md
|
2020-04-24 09:37:11 +02:00
|
|
|
- kubernetesDeploy: steps/kubernetesDeploy.md
|
2018-10-17 12:05:11 +02:00
|
|
|
- mailSendNotification: steps/mailSendNotification.md
|
2020-04-30 11:14:14 +02:00
|
|
|
- malwareExecuteScan: steps/malwareExecuteScan.md
|
2020-06-09 08:46:54 +02:00
|
|
|
- mavenBuild: steps/mavenBuild.md
|
2018-01-24 10:55:38 +02:00
|
|
|
- mavenExecute: steps/mavenExecute.md
|
2020-09-10 16:18:23 +02:00
|
|
|
- mavenExecuteIntegration: steps/mavenExecuteIntegration.md
|
2020-03-31 11:29:44 +02:00
|
|
|
- mavenExecuteStaticCodeChecks: steps/mavenExecuteStaticCodeChecks.md
|
2017-07-11 15:12:03 +02:00
|
|
|
- mtaBuild: steps/mtaBuild.md
|
2019-04-17 16:00:38 +02:00
|
|
|
- multicloudDeploy: steps/multicloudDeploy.md
|
2017-07-11 15:12:03 +02:00
|
|
|
- neoDeploy: steps/neoDeploy.md
|
2019-01-11 09:02:30 +02:00
|
|
|
- newmanExecute: steps/newmanExecute.md
|
2020-04-01 23:48:51 +02:00
|
|
|
- nexusUpload: steps/nexusUpload.md
|
2020-07-13 15:10:12 +02:00
|
|
|
- npmExecuteEndToEndTests: steps/npmExecuteEndToEndTests.md
|
2020-06-22 10:12:28 +02:00
|
|
|
- npmExecuteLint: steps/npmExecuteLint.md
|
2020-06-09 09:05:28 +02:00
|
|
|
- npmExecuteScripts: steps/npmExecuteScripts.md
|
2018-01-24 10:55:38 +02:00
|
|
|
- pipelineExecute: steps/pipelineExecute.md
|
2018-10-18 08:51:48 +02:00
|
|
|
- pipelineRestartSteps: steps/pipelineRestartSteps.md
|
2018-06-01 12:33:06 +02:00
|
|
|
- pipelineStashFiles: steps/pipelineStashFiles.md
|
2019-04-17 16:00:38 +02:00
|
|
|
- pipelineStashFilesAfterBuild: steps/pipelineStashFilesAfterBuild.md
|
|
|
|
|
- pipelineStashFilesBeforeBuild: steps/pipelineStashFilesBeforeBuild.md
|
2020-06-22 17:52:11 +02:00
|
|
|
- piperLoadGlobalExtensions: steps/piperLoadGlobalExtensions.md
|
2019-07-18 12:09:54 +02:00
|
|
|
- piperPublishWarnings: steps/piperPublishWarnings.md
|
2017-12-06 13:03:06 +02:00
|
|
|
- prepareDefaultValues: steps/prepareDefaultValues.md
|
2020-02-12 09:53:32 +02:00
|
|
|
- protecodeExecuteScan: steps/protecodeExecuteScan.md
|
2018-10-04 17:06:42 +02:00
|
|
|
- seleniumExecuteTests: steps/seleniumExecuteTests.md
|
2018-01-24 10:55:38 +02:00
|
|
|
- setupCommonPipelineEnvironment: steps/setupCommonPipelineEnvironment.md
|
2019-02-13 17:45:35 +02:00
|
|
|
- slackSendNotification: steps/slackSendNotification.md
|
2019-03-18 12:08:41 +02:00
|
|
|
- snykExecute: steps/snykExecute.md
|
2019-05-14 10:59:52 +02:00
|
|
|
- sonarExecuteScan: steps/sonarExecuteScan.md
|
2020-02-12 09:53:32 +02:00
|
|
|
- spinnakerTriggerPipeline: steps/spinnakerTriggerPipeline.md
|
2018-10-17 12:05:11 +02:00
|
|
|
- testsPublishResults: steps/testsPublishResults.md
|
2019-07-22 12:08:11 +02:00
|
|
|
- tmsUpload: steps/tmsUpload.md
|
2018-06-26 16:31:33 +02:00
|
|
|
- transportRequestCreate: steps/transportRequestCreate.md
|
|
|
|
|
- transportRequestRelease: steps/transportRequestRelease.md
|
|
|
|
|
- transportRequestUploadFile: steps/transportRequestUploadFile.md
|
2019-02-08 12:15:32 +02:00
|
|
|
- uiVeri5ExecuteTests: steps/uiVeri5ExecuteTests.md
|
2019-03-08 13:33:31 +02:00
|
|
|
- whitesourceExecuteScan: steps/whitesourceExecuteScan.md
|
2020-08-10 17:54:03 +02:00
|
|
|
- writeTemporaryCredentials: steps/writeTemporaryCredentials.md
|
2019-09-11 13:42:38 +02:00
|
|
|
- xsDeploy: steps/xsDeploy.md
|
2020-04-08 09:28:03 +02:00
|
|
|
- 'Library Steps (deprecated)':
|
|
|
|
|
- artifactSetVersion: steps/artifactSetVersion.md
|
2020-06-09 08:46:54 +02:00
|
|
|
- npmExecute: steps/npmExecute.md
|
2020-04-28 09:28:34 +02:00
|
|
|
- 'Command line tool': cli/index.md
|
2017-07-11 15:12:03 +02:00
|
|
|
|
2017-12-06 13:03:06 +02:00
|
|
|
theme:
|
2017-11-17 16:33:08 +02:00
|
|
|
name: 'material'
|
2017-07-11 15:12:03 +02:00
|
|
|
palette:
|
|
|
|
|
primary: 'teal'
|
|
|
|
|
accent: 'purple'
|
2017-11-17 16:33:08 +02:00
|
|
|
logo: 'images/piper_head_white.png'
|
|
|
|
|
favicon: 'images/favicon.ico'
|
|
|
|
|
extra:
|
2017-07-11 15:12:03 +02:00
|
|
|
font:
|
|
|
|
|
text: 'Slabo 13px'
|
|
|
|
|
code: 'Ubuntu Mono'
|
|
|
|
|
markdown_extensions:
|
|
|
|
|
- admonition
|
|
|
|
|
- codehilite(guess_lang=false)
|
|
|
|
|
- toc(permalink=true)
|
|
|
|
|
- footnotes
|
|
|
|
|
- pymdownx.superfences
|
2017-12-06 13:03:06 +02:00
|
|
|
extra_css:
|
2017-07-11 15:12:03 +02:00
|
|
|
- 'css/extra.css'
|
|
|
|
|
edit_uri: edit/master/documentation/docs
|
|
|
|
|
site_dir: docs-gen
|
|
|
|
|
repo_url: https://github.com/SAP/jenkins-library
|
