1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
sap-jenkins-library/documentation/docs/steps
Oliver Nocon 43f51ba90a
Revamp documentation generation for golang steps (#1781)
* Revamp documentation generation for golang steps

* Add and update tests

* Add tests, add step outputs

* Add tests, add step outputs

* Update rendering

* fix merge conflict

* update generated files

* Update pkg/config/stepmeta.go

* Update pkg/config/stepmeta.go

* Update pkg/generator/helper/docuHelper.go

Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>

* Include PR feedback

* update tests

* Fix Jenkins dependecy indication

Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>
2020-07-16 09:10:15 +02:00
..
abapEnvironmentPullGitRepo.md Change parameters/alias for CfServiceKeyName (#1726) 2020-06-30 15:46:07 +02:00
abapEnvironmentRunATCCheck.md Host parameter fix (#1752) 2020-07-07 16:19:57 +02:00
artifactPrepareVersion.md Revamp documentation generation for golang steps (#1781) 2020-07-16 09:10:15 +02:00
artifactSetVersion.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
batsExecuteTests.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
buildExecute.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
cfManifestSubstituteVariables.md Variable Substitution in YAML Files (#852) 2019-09-06 10:20:35 +02:00
checkChangeInDevelopment.md cm client only required in case we are not running via docker (#890) 2019-09-30 12:54:16 +02:00
checkmarxExecuteScan.md Checkmarx as golang (#1075) 2020-01-27 23:40:53 +01:00
checksPublishResults.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
cloudFoundryCreateService.md Fix bug and added documentation for cloudFoundryCreateService step (#967) 2019-11-12 10:29:08 +01:00
cloudFoundryCreateServiceKey.md Removing JSON config for Service Key Creation as in-line parameter (#1434) 2020-04-29 13:11:06 +02:00
cloudFoundryDeleteService.md Add ServiceKey deletion to cloudFoundryDeleteService step (#1177) 2020-03-05 15:35:43 +01:00
cloudFoundryDeploy.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
commonPipelineEnvironment.md remove outdated docu 2019-04-09 18:48:39 +02:00
containerExecuteStructureTests.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
containerPushToRegistry.md Add step buildExecute (#527) 2019-07-02 13:00:36 +02:00
detectExecuteScan.md Revamp documentation generation for golang steps (#1781) 2020-07-16 09:10:15 +02:00
dockerExecute.md Patch Urls (#929) 2019-11-11 17:40:23 +01:00
dockerExecuteOnKubernetes.md User piper docker images (#920) 2019-10-25 17:49:54 +02:00
dubExecute.md Add dubExecute step (#754) 2019-06-19 16:52:18 +02:00
durationMeasure.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
fortifyExecuteScan.md Fortify implementation in golang (#1428) 2020-05-25 19:48:59 +02:00
gaugeExecuteTests.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
gctsCloneRepository.md Introducing new step 'gctsCloneRepository' (#1468) 2020-06-18 07:45:22 +02:00
gctsCreateRepository.md Minor improvements to gctsCreateRepository step docu and metadata (#1469) 2020-04-29 16:21:55 +02:00
gctsDeployCommit.md Introducing new step 'gctsDeployCommit' (#1476) 2020-05-18 21:39:35 +02:00
gctsExecuteABAPUnitTests.md Introducing new step 'gctsExecuteABAPUnitTests' (#1532) 2020-07-14 10:58:57 +02:00
githubPublishRelease.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
hadolintExecute.md Add new step for Dockerfile linting (#723) 2019-06-04 08:01:43 +02:00
handlePipelineStepErrors.md Update handlePipelineStepErrors.md (#1247) 2020-03-05 10:19:02 +01:00
healthExecuteCheck.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
influxWriteData.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
jenkinsMaterializeLog.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
kanikoExecute.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
karmaExecuteTests.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
kubernetesDeploy.md feat(k8s): Add basic support for Helm 3 in kubernetesDeploy step (#1438) 2020-04-24 09:37:11 +02:00
mailSendNotification.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
malwareExecuteScan.md Fix credential parameter in the docu (#1597) 2020-06-02 10:04:56 +02:00
mavenBuild.md Document mavenBuild (#1439) 2020-04-22 16:43:10 +02:00
mavenExecute.md Improve docs on new mavenExecute api (#1525) 2020-05-11 13:52:42 +02:00
mavenExecuteStaticCodeChecks.md Add documentation for mavenExecuteStaticCodeChecks groovy part (#1339) 2020-03-31 11:29:44 +02:00
mtaBuild.md Merge branch 'master' of github.com:SAP/jenkins-library into revdoc 2019-06-12 11:47:37 +02:00
multicloudDeploy.md Fix code climate issues 2019-05-24 16:18:45 +02:00
neoDeploy.md Remove reference to outdated neoHome setting (#1180) 2020-02-17 10:52:05 +01:00
newmanExecute.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
nexusUpload.md Generate documentation for nexusUpload (#1356) 2020-04-01 23:48:51 +02:00
npmExecute.md Fix code climate issues 2019-05-24 16:18:45 +02:00
npmExecuteEndToEndTests.md Add step for end to end test execution (#1786) 2020-07-13 15:10:12 +02:00
npmExecuteLint.md Add Java-/Typescript linting capabilities (#1636) 2020-06-22 10:12:28 +02:00
npmExecuteScripts.md Document new npmExecuteScripts and mavenBuild steps (#1632) 2020-06-09 08:46:54 +02:00
pipelineExecute.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
pipelineRestartSteps.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
pipelineStashFiles.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
pipelineStashFilesAfterBuild.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
pipelineStashFilesBeforeBuild.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
piperLoadGlobalExtensions.md Load global extensions in setupCommonPipelineEnvironment (#1688) 2020-06-22 17:52:11 +02:00
piperPublishWarnings.md add new step piperPublishNotifications (#652) 2019-07-18 12:09:54 +02:00
prepareDefaultValues.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
protecodeExecuteScan.md docs: Fix old protecode host url (#1745) 2020-07-06 11:26:37 +02:00
seleniumExecuteTests.md Patch Urls (#929) 2019-11-11 17:40:23 +01:00
setupCommonPipelineEnvironment.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
slackSendNotification.md Merge remote-tracking branch 'github/master' into HEAD 2019-05-24 16:14:19 +02:00
snykExecute.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
sonarExecuteScan.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
spinnakerTriggerPipeline.md Add missing pages to documentation (#1172) 2020-02-12 08:53:32 +01:00
testsPublishResults.md docs: fix typo in headline Prerequsites (#1461) 2020-04-26 19:50:39 +02:00
tmsUpload.md TMS integration (#782) 2019-07-18 15:06:11 +02:00
transportRequestCreate.md cm client only required in case we are not running via docker (#890) 2019-09-30 12:54:16 +02:00
transportRequestRelease.md cm client only required in case we are not running via docker (#890) 2019-09-30 12:54:16 +02:00
transportRequestUploadFile.md transport request upload file: Short notice about not working CTS upload (#1631) 2020-06-16 08:13:49 +02:00
uiVeri5ExecuteTests.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
whitesourceExecuteScan.md More speaking name in doc wrt jenkins plugin deps 2019-05-24 15:44:31 +02:00
xsDeploy.md correct typos in xsDeploy documentation (#921) 2019-10-28 12:05:52 +01:00