mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
41dcebb3a5
* 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.
101 lines
4.7 KiB
YAML
101 lines
4.7 KiB
YAML
site_name: Jenkins 2.0 Pipelines
|
|
nav:
|
|
- Home: index.md
|
|
- 'Guided Tour' : guidedtour.md
|
|
- Configuration: configuration.md
|
|
- Extensibility: extensibility.md
|
|
- 'Library steps':
|
|
- artifactSetVersion: steps/artifactSetVersion.md
|
|
- batsExecuteTests: steps/batsExecuteTests.md
|
|
- checkChangeInDevelopment: steps/checkChangeInDevelopment.md
|
|
- checksPublishResults: steps/checksPublishResults.md
|
|
- cfManifestSubstituteVariables: steps/cfManifestSubstituteVariables.md
|
|
- cloudFoundryDeploy: steps/cloudFoundryDeploy.md
|
|
- commonPipelineEnvironment: steps/commonPipelineEnvironment.md
|
|
- containerExecuteStructureTests: steps/containerExecuteStructureTests.md
|
|
- detectExecuteScan: steps/detectExecuteScan.md
|
|
- dockerExecute: steps/dockerExecute.md
|
|
- dockerExecuteOnKubernetes: steps/dockerExecuteOnKubernetes.md
|
|
- dubExecute: steps/dubExecute.md
|
|
- durationMeasure: steps/durationMeasure.md
|
|
- gaugeExecuteTests: steps/gaugeExecuteTests.md
|
|
- githubPublishRelease: steps/githubPublishRelease.md
|
|
- hadolintExecute: steps/hadolintExecute.md
|
|
- handlePipelineStepErrors: steps/handlePipelineStepErrors.md
|
|
- healthExecuteCheck: steps/healthExecuteCheck.md
|
|
- influxWriteData: steps/influxWriteData.md
|
|
- kanikoExecute: steps/kanikoExecute.md
|
|
- karmaExecuteTests: steps/karmaExecuteTests.md
|
|
- mailSendNotification: steps/mailSendNotification.md
|
|
- mavenExecute: steps/mavenExecute.md
|
|
- mtaBuild: steps/mtaBuild.md
|
|
- multicloudDeploy: steps/multicloudDeploy.md
|
|
- neoDeploy: steps/neoDeploy.md
|
|
- newmanExecute: steps/newmanExecute.md
|
|
- npmExecute: steps/npmExecute.md
|
|
- pipelineExecute: steps/pipelineExecute.md
|
|
- pipelineRestartSteps: steps/pipelineRestartSteps.md
|
|
- pipelineStashFiles: steps/pipelineStashFiles.md
|
|
- pipelineStashFilesAfterBuild: steps/pipelineStashFilesAfterBuild.md
|
|
- pipelineStashFilesBeforeBuild: steps/pipelineStashFilesBeforeBuild.md
|
|
- piperPublishWarnings: steps/piperPublishWarnings.md
|
|
- prepareDefaultValues: steps/prepareDefaultValues.md
|
|
- seleniumExecuteTests: steps/seleniumExecuteTests.md
|
|
- setupCommonPipelineEnvironment: steps/setupCommonPipelineEnvironment.md
|
|
- slackSendNotification: steps/slackSendNotification.md
|
|
- snykExecute: steps/snykExecute.md
|
|
- sonarExecuteScan: steps/sonarExecuteScan.md
|
|
- testsPublishResults: steps/testsPublishResults.md
|
|
- tmsUpload: steps/tmsUpload.md
|
|
- transportRequestCreate: steps/transportRequestCreate.md
|
|
- transportRequestRelease: steps/transportRequestRelease.md
|
|
- transportRequestUploadFile: steps/transportRequestUploadFile.md
|
|
- uiVeri5ExecuteTests: steps/uiVeri5ExecuteTests.md
|
|
- whitesourceExecuteScan: steps/whitesourceExecuteScan.md
|
|
- 'Pipelines':
|
|
- '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
|
|
- 'Scenarios':
|
|
- 'Build and Deploy Hybrid Applications with Jenkins and SAP Solution Manager': scenarios/changeManagement.md
|
|
- 'Build and Deploy SAP UI5 or SAP Fiori Applications on SAP Cloud Platform with Jenkins': scenarios/ui5-sap-cp/Readme.md
|
|
- 'Build and Deploy Applications with Jenkins and the SAP Cloud Application Programming Model': scenarios/CAP_Scenario.md
|
|
- Resources:
|
|
- 'Required Plugins': jenkins/requiredPlugins.md
|
|
|
|
theme:
|
|
name: 'material'
|
|
palette:
|
|
primary: 'teal'
|
|
accent: 'purple'
|
|
logo: 'images/piper_head_white.png'
|
|
favicon: 'images/favicon.ico'
|
|
extra:
|
|
font:
|
|
text: 'Slabo 13px'
|
|
code: 'Ubuntu Mono'
|
|
markdown_extensions:
|
|
- admonition
|
|
- codehilite(guess_lang=false)
|
|
- toc(permalink=true)
|
|
- footnotes
|
|
- pymdownx.superfences
|
|
extra_css:
|
|
- 'css/extra.css'
|
|
edit_uri: edit/master/documentation/docs
|
|
site_dir: docs-gen
|
|
repo_url: https://github.com/SAP/jenkins-library
|