jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
Code Issues Releases Activity
211827ac93
sap-jenkins-library/documentation/mkdocs.yml

100 lines
4.6 KiB
YAML
Raw Normal View History

Initial version of piper-lib.
2017-07-11 15:12:03 +02:00
site_name: Jenkins 2.0 Pipelines
fix mkdocs issue - introduced docker mkdocs build - changed pages to nav in mkdocs.yml due to newer mkdocs version
2018-09-25 14:03:22 +02:00
nav:
Initial version of piper-lib.
2017-07-11 15:12:03 +02:00
- Home: index.md
review documentation - clear separation of README.md from https://sap.github.io/jenkins-library/ - enhanced https://sap.github.io/jenkins-library/home - introduction of guided tour
2019-05-17 14:35:08 +02:00
- 'Guided Tour' : guidedtour.md
Add collection of library telemetry data (#239) * add telemetry collection * add telemetry reporting for first steps * fix documentation formatting
2018-08-06 08:57:36 +02:00
- Configuration: configuration.md
Piper pipeline - enhance stages (#755) * fill PRVoting stage with content * add prVoting stage incl. tests * add Build stage incl. Tests * add docs pages * add additional unit test stage * add acceptance stage and additional documentation ... * add release stage content * add promote stage * add Security stage, fix defaults for Promote stage * fix issue in doc generation
2019-07-03 10:13:26 +02:00
- Extensibility: extensibility.md
Initial version of piper-lib.
2017-07-11 15:12:03 +02:00
- 'Library steps':
Step for automatic versioning (#65) It contains: * versioning step artifactSetVersion * versioning implementation for Maven & Docker * enhancements to commonPipelineEnvironment * extended default configuration * new utils object for git-related tasks * automated tests incl. new Rules and resources * incorporated PR feedback * step documentation
2018-02-07 14:17:33 +02:00
- artifactSetVersion: steps/artifactSetVersion.md
batsExecuteTests - add step for executing bats-core (#254) details are available in the documentation contained in this PR
2018-08-15 11:41:01 +02:00
- batsExecuteTests: steps/batsExecuteTests.md
Add collection of library telemetry data (#239) * add telemetry collection * add telemetry reporting for first steps * fix documentation formatting
2018-08-06 08:57:36 +02:00
- checkChangeInDevelopment: steps/checkChangeInDevelopment.md
add step mailSendNotification (#336) This step allows to send email notifications in case of pipeline failures.
2018-10-17 12:05:11 +02:00
- checksPublishResults: steps/checksPublishResults.md
update docs
2018-08-15 09:30:35 +02:00
- cloudFoundryDeploy: steps/cloudFoundryDeploy.md
Initial version of piper-lib.
2017-07-11 15:12:03 +02:00
- commonPipelineEnvironment: steps/commonPipelineEnvironment.md
Add step containerExecuteStructureTest (#441) * add step containerExecuteStructureTest * include PR-review feedback * documentation
2019-01-31 10:39:13 +02:00
- containerExecuteStructureTests: steps/containerExecuteStructureTests.md
detectExecuteScan - add doc to docs structure (#699)
2019-05-10 08:06:38 +02:00
- detectExecuteScan: steps/detectExecuteScan.md
InfluxDB support (#52) * adding step for writing metrics to InfluxDB including dependencies * added documentation * incorporated PR feedback
2018-01-24 10:55:38 +02:00
- dockerExecute: steps/dockerExecute.md
Enable support for executing on K8S as a step (#231) * Create executeDockerOnKubernetes.groovy * Update dockerExecute.groovy * Create SysEnvTest.groovy * Update default_pipeline_environment.yml * Update executeDockerOnKubernetes.groovy * Create utils object * update docker image * Update mavenExecute.groovy * Use pipeline-lib than piper * Check container name * Always change ownership to 1000 * Check for map * Fix command * Move chmod to docker execute * Use generic name for the pod * runAsPod has been added * Return false if script has no k8smapping * fix syntax error * Null checks * Returnn dockerImage name * Check method body * Return container name * Cleanup echos * Use runAsPod * Rename step * Use official jenkins JNLP agent image * Construct containersMap * Check if kubernetes plugin is active * Support JaaS * pass script object * Move configuration to default section * Use generic flag to check if running in k8s * fix jnlp agent name * Solve travis errors * Improvements to config and changes to name of the method * Improvements to config * Fix type * Rename stash config * add import * Fix map order * Fix jnlp agent name * cleanup config usage * Check if config is enabled * Use nested k8s mapping * Support custom docker workspace and move flag to env * Feature/k8s stage (#1) * Use nested k8s mapping * Support custom docker workspace and move flag to env * Check dockerOptions value * Support local execution * Add tests for dockerExecute * Move config to step and Fix tests * Use step configuration while running as a pod * Streamline parameter and config initialization * Streamline parameter and tests * Cleanup and align variable name * Use default JNLP agent if one not defined in config * Add tests for runInsidePod. Ensure lowercase container names. * Improve tests and remove unused code block * Fix permission issues * Perform stashing and unstashing inside container * Use custom jnlp agent due to user id restriction * Fix tests after jnlp agent change * Address review comments * Initialize script to default value if null * Address review comments * Update exeception handling and documentation * Improve documentation * correct indent * Link documents to the index page * Merge containerExecute and dockerExecuteOnKuberenetes step and address comments. * Update dockerExecute.md * Update dockerExecuteOnKubernetes.md * Update default_pipeline_environment.yml * update documentation * Update documentation. Use annotation for singleton * Update DockerExecuteOnKubernetesTest.groovy * Update dockerExecute.groovy * Update dockerExecuteOnKubernetes.groovy * Improve documentation and test case names * neoDeploy: switch to chained ConfigurationHelper (#244) * switch neoDeploy to chained ConfigurationHelper * update imports * Improve tests * Address review comments * Improve documentation * made dockerImage non-mandatory parm, improved test * add comment regarding userid assumption
2018-08-21 15:45:59 +02:00
- dockerExecuteOnKubernetes: steps/dockerExecuteOnKubernetes.md
Add dubExecute step (#754) * Add dubExecute step * Fix test
2019-06-19 16:52:18 +02:00
- dubExecute: steps/dubExecute.md
InfluxDB support (#52) * adding step for writing metrics to InfluxDB including dependencies * added documentation * incorporated PR feedback
2018-01-24 10:55:38 +02:00
- durationMeasure: steps/durationMeasure.md
add step gaugeExecuteTests (#340) * seleniumExecuteTests - fixes * add step gaugeExecuteTests incl. tests * add documentation * add more config options
2018-10-17 16:44:20 +02:00
- gaugeExecuteTests: steps/gaugeExecuteTests.md
add new step docu to index
2019-04-17 16:00:38 +02:00
- githubPublishRelease: steps/githubPublishRelease.md
add HaDoLint to docs (#744)
2019-06-06 13:52:20 +02:00
- hadolintExecute: steps/hadolintExecute.md
Initial version of piper-lib.
2017-07-11 15:12:03 +02:00
- handlePipelineStepErrors: steps/handlePipelineStepErrors.md
add step healthExecuteCheck (#339) This step allows to perform a basic health check on an installed application. It verifies that your app has a simple health endpoint available and that there is no error when calling it.
2018-10-12 16:06:41 +02:00
- healthExecuteCheck: steps/healthExecuteCheck.md
InfluxDB support (#52) * adding step for writing metrics to InfluxDB including dependencies * added documentation * incorporated PR feedback
2018-01-24 10:55:38 +02:00
- influxWriteData: steps/influxWriteData.md
Add kanikoExec to docu index (#714) was missing in mkdocs.yml
2019-06-19 11:08:09 +02:00
- kanikoExecute: steps/kanikoExecute.md
add new step karmaExecuteTests (#351) * add new step for karma execution * add defaults * Update karmaExecuteTests.groovy * add key comments * add test case * docs * add step docs * add step docs * Update karmaExecuteTests.md * complete docs * Update karmaExecuteTests.md * init `script` the "new way" * Update karmaExecuteTests.groovy * Update karmaExecuteTests.groovy
2018-11-08 13:15:15 +02:00
- karmaExecuteTests: steps/karmaExecuteTests.md
add step mailSendNotification (#336) This step allows to send email notifications in case of pipeline failures.
2018-10-17 12:05:11 +02:00
- mailSendNotification: steps/mailSendNotification.md
InfluxDB support (#52) * adding step for writing metrics to InfluxDB including dependencies * added documentation * incorporated PR feedback
2018-01-24 10:55:38 +02:00
- mavenExecute: steps/mavenExecute.md
Initial version of piper-lib.
2017-07-11 15:12:03 +02:00
- mtaBuild: steps/mtaBuild.md
add new step docu to index
2019-04-17 16:00:38 +02:00
- multicloudDeploy: steps/multicloudDeploy.md
Initial version of piper-lib.
2017-07-11 15:12:03 +02:00
- neoDeploy: steps/neoDeploy.md
docs: add reference to newman page (#430)
2019-01-11 09:02:30 +02:00
- newmanExecute: steps/newmanExecute.md
Add npmExecute step (#491)
2019-02-21 20:14:48 +02:00
- npmExecute: steps/npmExecute.md
InfluxDB support (#52) * adding step for writing metrics to InfluxDB including dependencies * added documentation * incorporated PR feedback
2018-01-24 10:55:38 +02:00
- pipelineExecute: steps/pipelineExecute.md
add step pipelineRestartSteps (#337) This step allows to restart a set of steps in order to retry in case of e.g. infrastructure failures which first need to be fixed. * update documentation
2018-10-18 08:51:48 +02:00
- pipelineRestartSteps: steps/pipelineRestartSteps.md
pipelineStashFiles - cleanup & documentation This contains some cleanups to the code plus documentation for the step
2018-06-01 12:33:06 +02:00
- pipelineStashFiles: steps/pipelineStashFiles.md
add new step docu to index
2019-04-17 16:00:38 +02:00
- pipelineStashFilesAfterBuild: steps/pipelineStashFilesAfterBuild.md
- pipelineStashFilesBeforeBuild: steps/pipelineStashFilesBeforeBuild.md
add new step piperPublishNotifications (#652) * add new step for notification publication * add test cases * add helper method * correct import * Update pom.xml * add step to post section * add step piperPublishNotifications * move step to end of pipeline to gather all findings * use handlePipelineStepErrors step * use commonPipelineEnvironment * correct reporting * add configuration * fix typos * fix rule setup * remove test scope * add method to fetch full build log * add methods for warnings-ng parser creation * remove warnings plugin coding * add default parser settings * change parameter handling for parser creation * adapt step * fix parser creation * use ParserConfig.contains * use correct parameter name * correct parser regex * change issue creation * use classloader * fix typo * Revert "fix typo" This reverts commit 446a201ae44ae0bf6bcfedd17e583183ceaabfaa. * Revert "use classloader" This reverts commit a89648703239f8cf3da465bfa570500608dc14f2. * rename step to piperPublishWarnings * extract recordIssuesSettings to defaults * make addWarningsNGParser non-static * remove node * adjust test case * add docs * rename log file * fix tests * fix typos * rename parameter * add import for IOUtils * check plugin activation * add comment for class loader usage
2019-07-18 12:09:54 +02:00
- piperPublishWarnings: steps/piperPublishWarnings.md
Enable configuration via yaml file + mavenExecute as example (#18) * Enable configuration via yaml file * Add documentation * Add tests
2017-12-06 13:03:06 +02:00
- prepareDefaultValues: steps/prepareDefaultValues.md
seleniumExecuteTests - add step to run Selenium tests (#318) It comes with an extension to executeDocker and executeDockerOnKubernetes to run sidecar containers. This helps to execute Selenium tests using two Docker images: 1. Execution runtime for tests (e.g. node image) 2. Selenium instance which holds Selenium server + browser * add documentation & some name cleanup * include PR feedback * add step documentation to structure
2018-10-04 17:06:42 +02:00
- seleniumExecuteTests: steps/seleniumExecuteTests.md
InfluxDB support (#52) * adding step for writing metrics to InfluxDB including dependencies * added documentation * incorporated PR feedback
2018-01-24 10:55:38 +02:00
- setupCommonPipelineEnvironment: steps/setupCommonPipelineEnvironment.md
add step slackSendNotification (#338) * add step slackSendNotification This step allows to send Slack notifications in case of pipeline failures. * add SWA reporting * remove allowBuildFailure * add GENERAL_CONFIG_KEYS * update STEP_NAME * add missing import * fix MD findings * adjust rule name to be aligned with #455
2019-02-13 17:45:35 +02:00
- slackSendNotification: steps/slackSendNotification.md
snykExecute: add missing documentation (#570) * add docs for snykExecute * add link to new docs page
2019-03-18 12:08:41 +02:00
- snykExecute: steps/snykExecute.md
add Sonar docs link (#704)
2019-05-14 10:59:52 +02:00
- sonarExecuteScan: steps/sonarExecuteScan.md
add step mailSendNotification (#336) This step allows to send email notifications in case of pipeline failures.
2018-10-17 12:05:11 +02:00
- testsPublishResults: steps/testsPublishResults.md
Add tmpUpload to mkdocs index page (#801)
2019-07-22 12:08:11 +02:00
- tmsUpload: steps/tmsUpload.md
Add new transport related steps to documentation index
2018-06-26 16:31:33 +02:00
- transportRequestCreate: steps/transportRequestCreate.md
- transportRequestRelease: steps/transportRequestRelease.md
- transportRequestUploadFile: steps/transportRequestUploadFile.md
publish docu for step uiVeri5ExecuteTests (#499)
2019-02-08 12:15:32 +02:00
- uiVeri5ExecuteTests: steps/uiVeri5ExecuteTests.md
Updated documentation
2019-03-08 13:33:31 +02:00
- whitesourceExecuteScan: steps/whitesourceExecuteScan.md
Piper pipeline - enhance stages (#755) * fill PRVoting stage with content * add prVoting stage incl. tests * add Build stage incl. Tests * add docs pages * add additional unit test stage * add acceptance stage and additional documentation ... * add release stage content * add promote stage * add Security stage, fix defaults for Promote stage * fix issue in doc generation
2019-07-03 10:13:26 +02:00
- '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
Docker Pipeline - fixes and small adoptions (#779) * buildExecute: Docker case - minor fixes * properly care for empty `containerBuildOptions` * verbose output wrt stashing * add stage ordinals * fix wrong script reference * fix null reference * adapt stage defaults and allow bats tests * propagate github org and repo * add test for bats
2019-07-05 16:32:24 +02:00
- 'Build Stage': stages/build.md
Piper pipeline - enhance stages (#755) * fill PRVoting stage with content * add prVoting stage incl. tests * add Build stage incl. Tests * add docs pages * add additional unit test stage * add acceptance stage and additional documentation ... * add release stage content * add promote stage * add Security stage, fix defaults for Promote stage * fix issue in doc generation
2019-07-03 10:13:26 +02:00
- '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
New Scenario Step: SAP UI5 on SAP Cloud Platform (#388) This scenario builds a UI5 app and deploys it to SAP Cloud Platform (neo).
2019-01-15 14:32:01 +02:00
- 'Scenarios':
Align Navigation Text with Header
2019-02-05 19:46:27 +02:00
- 'Build and Deploy Hybrid Applications with Jenkins and SAP Solution Manager': scenarios/changeManagement.md
Add CAP Scenario in Navigation (#502)
2019-02-08 16:45:24 +02:00
- '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
review documentation - clear separation of README.md from https://sap.github.io/jenkins-library/ - enhanced https://sap.github.io/jenkins-library/home - introduction of guided tour
2019-05-17 14:35:08 +02:00
- Resources:
- 'Required Plugins': jenkins/requiredPlugins.md
Initial version of piper-lib.
2017-07-11 15:12:03 +02:00
Enable configuration via yaml file + mavenExecute as example (#18) * Enable configuration via yaml file * Add documentation * Add tests
2017-12-06 13:03:06 +02:00
theme:
Update mkdocs.yml to MkDocs 0.17.0 format MkDocs 0.17 features theme customization options [1] which are picked up supported with mkdocs-material 2.0.1 [2] and later. These are now the minimum required versions to compile our gh-pages documentation. [1] http://www.mkdocs.org/about/release-notes/#major-additions-to-version-0170 [2] https://github.com/squidfunk/mkdocs-material/releases/tag/2.0.0
2017-11-17 16:33:08 +02:00
name: 'material'
Initial version of piper-lib.
2017-07-11 15:12:03 +02:00
palette:
primary: 'teal'
accent: 'purple'
Update mkdocs.yml to MkDocs 0.17.0 format MkDocs 0.17 features theme customization options [1] which are picked up supported with mkdocs-material 2.0.1 [2] and later. These are now the minimum required versions to compile our gh-pages documentation. [1] http://www.mkdocs.org/about/release-notes/#major-additions-to-version-0170 [2] https://github.com/squidfunk/mkdocs-material/releases/tag/2.0.0
2017-11-17 16:33:08 +02:00
logo: 'images/piper_head_white.png'
favicon: 'images/favicon.ico'
extra:
Initial version of piper-lib.
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
Enable configuration via yaml file + mavenExecute as example (#18) * Enable configuration via yaml file * Add documentation * Add tests
2017-12-06 13:03:06 +02:00
extra_css:
Initial version of piper-lib.
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
Reference in New Issue Copy Permalink