sap-jenkins-library

mirror of https://github.com/SAP/jenkins-library.git synced 2025-12-01 23:02:43 +02:00

Files

Niklas Albers 8c5986bbfa Improve documentation for protecodeExecuteScan (#3076 )

* Improve documentation for protecodeExecuteScan

protecodeExecuteScan expects that the docker config file is named
'config.json'.

The dockerConfigJSON parameter is used by protecodeExecuteScan to
retrieve the directory only (for environment variable DOCKER_CONFIG).

* Also improve documentation that is generated

* No relative references in generated documentation.

* Less complex documentation

* Remove irrelevant empty line

* Improvements after review

* Add blank line after code block

* Handle registry URL example as code

Markdown format checker does not like raw URLs.

Co-authored-by: Sven Merk <33895725+nevskrem@users.noreply.github.com>

2021-09-01 10:57:21 +02:00

abapAddonAssemblyKitCheckCVs.md

Technical Communication User (#2931 )

2021-06-21 17:56:12 +02:00

abapAddonAssemblyKitCheckPV.md

Technical Communication User (#2931 )

2021-06-21 17:56:12 +02:00

abapAddonAssemblyKitCreateTargetVector.md

Technical Communication User (#2931 )

2021-06-21 17:56:12 +02:00

abapAddonAssemblyKitPublishTargetVector.md

Technical Communication User (#2931 )

2021-06-21 17:56:12 +02:00

abapAddonAssemblyKitRegisterPackages.md

Technical Communication User (#2931 )

2021-06-21 17:56:12 +02:00

abapAddonAssemblyKitReleasePackages.md

Technical Communication User (#2931 )

2021-06-21 17:56:12 +02:00

abapAddonAssemblyKitReserveNextPackages.md

Technical Communication User (#2931 )

2021-06-21 17:56:12 +02:00

abapEnvironmentAssembleConfirm.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

abapEnvironmentAssemblePackages.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

abapEnvironmentCheckoutBranch.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

abapEnvironmentCloneGitRepo.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

abapEnvironmentCreateSystem.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

abapEnvironmentPullGitRepo.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

abapEnvironmentRunATCCheck.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01: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

…

checkChangeInDevelopment.md

Remove cm client as prerequisite since we are expecting always a docker environment (#2511 )

2021-01-14 09:35:31 +01:00

checkmarxExecuteScan.md

Checkmarx as golang (#1075 )

2020-01-27 23:40:53 +01:00

checksPublishResults.md

fix(docs): typo in sample parameter (#2433 )

2020-11-30 08:57:48 +01:00

cloudFoundryCreateService.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

cloudFoundryCreateServiceKey.md

Removing JSON config for Service Key Creation as in-line parameter (#1434 )

2020-04-29 13:11:06 +02:00

cloudFoundryCreateSpace.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

cloudFoundryDeleteService.md

Fix parameter keys in example (#2693 )

2021-08-26 13:53:07 +02:00

cloudFoundryDeleteSpace.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

cloudFoundryDeploy.md

CommitHash for deployment details in influx (#3028 )

2021-08-05 17:03:51 +02:00

cnbBuild.md

cnbBuild step MVP (#3021 )

2021-08-18 12:10:55 +02:00

commonPipelineEnvironment.md

…

containerExecuteStructureTests.md

…

containerPushToRegistry.md

Add option to tag artifact version to containerPushToRegistryStep (#2859 )

2021-06-28 08:02:06 +02:00

debugReportArchive.md

Update Cloud SDK documentation (#2081 )

2020-09-29 11:26:55 +02:00

detectExecuteScan.md

detectExecuteScan: fix docs (#1835 )

2020-07-24 13:45:52 +02:00

dockerExecute.md

support credentials for docker pull (#1990 )

2020-09-23 11:50:57 +02:00

dockerExecuteOnKubernetes.md

use v6 version of ppiper/cf-cli consistently for all go steps (#2569 )

2021-02-11 09:31:25 +01:00

dubExecute.md

…

durationMeasure.md

…

fortifyExecuteScan.md

fix: markdownlint findings for MD012 (#2383 )

2020-11-16 18:22:38 +01:00

gatlingExecuteTests.md

New step gatlingExecuteTests, used in Performance stage (#2298 )

2020-11-03 17:42:02 +01:00

gaugeExecuteTests.md

docs: fix typo in headline Prerequsites (#1461 )

2020-04-26 19:50:39 +02:00

gctsCloneRepository.md

fix(typo): found by misspell (#2064 )

2020-09-24 07:41:06 +02:00

gctsCreateRepository.md

fix(typo): found by misspell (#2064 )

2020-09-24 07:41:06 +02:00

gctsDeploy.md

Improved documentation for gctsDeploy (#3054 )

2021-08-20 12:54:55 +02:00

gctsExecuteABAPUnitTests.md

fix(typo): found by misspell (#2064 )

2020-09-24 07:41:06 +02:00

gctsRollback.md

fix(typo): found by misspell (#2064 )

2020-09-24 07:41:06 +02:00

githubCheckBranchProtection.md

Add step to set GitHub status (#2012 )

2020-09-14 18:08:24 +02:00

githubCommentIssue.md

add step to create a GitHub comment (#2479 )

2020-12-21 16:21:07 +01:00

githubCreateIssue.md

add step to create a GitHub issue (#2481 )

2020-12-21 17:13:16 +01:00

githubCreatePullRequest.md

GitHub steps: convenience updates (#2026 )

2020-09-15 17:50:55 +02:00

githubPublishRelease.md

…

githubSetCommitStatus.md

Add step to set GitHub status (#2012 )

2020-09-14 18:08:24 +02:00

gitopsUpdateDeployment.md

Create missing documentation for step gitopsUpdateDeployment (#3003 )

2021-07-30 12:45:14 +02:00

hadolintExecute.md

…

handlePipelineStepErrors.md

Update handlePipelineStepErrors.md (#1247 )

2020-03-05 10:19:02 +01:00

healthExecuteCheck.md

fix(typo): found by misspell (#2064 )

2020-09-24 07:41:06 +02:00

influxWriteData.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

integrationArtifactDeploy.md

Remove version from deploy step (#2978 )

2021-07-27 09:51:56 +02:00

integrationArtifactDownload.md

CPI- Refactor Credential ID (#2946 )

2021-06-28 14:54:03 +02:00

integrationArtifactGetMplStatus.md

CPI- Refactor Credential ID (#2946 )

2021-06-28 14:54:03 +02:00

integrationArtifactGetServiceEndpoint.md

CPI- Remove platform parameter (#2956 )

2021-06-30 14:32:30 +02:00

integrationArtifactResource.md

IntegrationArtifactResource Command (#3027 )

2021-08-12 09:11:02 +02:00

integrationArtifactTriggerIntegrationTest.md

Refactor all instances of iFlow to be integrationFlow (#2992 )

2021-08-04 16:42:25 +02:00

integrationArtifactUnDeploy.md

IntegrationArtifactUnDeploy Command (#3018 )

2021-08-02 16:27:16 +02:00

integrationArtifactUpdateConfiguration.md

CPI- Remove platform parameter (#2956 )

2021-06-30 14:32:30 +02:00

integrationArtifactUpload.md

integrationArtifactUpload Fixes (#2987 )

2021-07-16 16:09:55 +02:00

jenkinsMaterializeLog.md

docs: fix typo in headline Prerequsites (#1461 )

2020-04-26 19:50:39 +02:00

kanikoExecute.md

fix(docs): typo: articale -> article (#1810 )

2020-07-16 13:11:48 +02:00

karmaExecuteTests.md

…

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

fix: markdownlint findings for MD012 (#2383 )

2020-11-16 18:22:38 +01:00

mavenExecute.md

fix(typo): found by misspell (#2064 )

2020-09-24 07:41:06 +02:00

mavenExecuteIntegration.md

New step mavenExecuteIntegration (#1829 )

2020-07-29 19:51:27 +02:00

mavenExecuteStaticCodeChecks.md

Add documentation for mavenExecuteStaticCodeChecks groovy part (#1339 )

2020-03-31 11:29:44 +02:00

mtaBuild.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

multicloudDeploy.md

…

neoDeploy.md

SAP CP to SAP BTP Rebranding (#2703 )

2021-03-19 10:51:24 +01:00

newmanExecute.md

feat(newmanExecute): golang implmementation for newmanExecute (#2513 )

2021-03-17 08:08:33 +01:00

nexusUpload.md

Generate documentation for nexusUpload (#1356 )

2020-04-01 23:48:51 +02:00

npmExecute.md

…

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

fix: markdownlint findings for MD012 (#2383 )

2020-11-16 18:22:38 +01:00

pipelineExecute.md

…

pipelineRestartSteps.md

…

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

…

prepareDefaultValues.md

…

protecodeExecuteScan.md

Improve documentation for protecodeExecuteScan (#3076 )

2021-09-01 10:57:21 +02:00

seleniumExecuteTests.md

Patch Urls (#929 )

2019-11-11 17:40:23 +01:00

setupCommonPipelineEnvironment.md

…

slackSendNotification.md

…

snykExecute.md

…

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

…

transportRequestCreate.md

Remove cm client as prerequisite since we are expecting always a docker environment (#2511 )

2021-01-14 09:35:31 +01:00

transportRequestDocIDFromGit.md

solman upload split git documentation (#2831 )

2021-06-10 10:16:22 +02:00

transportRequestRelease.md

Remove cm client as prerequisite since we are expecting always a docker environment (#2511 )

2021-01-14 09:35:31 +01:00

transportRequestReqIDFromGit.md

solman upload split git documentation (#2831 )

2021-06-10 10:16:22 +02:00

transportRequestUploadFile.md

Remove cm client as prerequisite since we are expecting always a docker environment (#2511 )

2021-01-14 09:35:31 +01:00

transportRequestUploadRFC.md

RFC Upload Documentation (#2922 )

2021-07-08 11:07:08 +02:00

transportRequestUploadSOLMAN.md

solman upload split git documentation (#2831 )

2021-06-10 10:16:22 +02:00

uiVeri5ExecuteTests.md

Update uiVeri5ExecuteTests.md (#3045 )

2021-08-19 14:21:46 +02:00

vaultRotateSecretId.md

Feature/approle secret id rotation (#2311 )

2020-11-17 13:49:31 +01:00

whitesourceExecuteScan.md

Removed obsolete scanTape, changed to buildTool (#2816 )

2021-05-06 09:33:05 +02:00

writeTemporaryCredentials.md

Add groovy wrapper for TemporaryCredentialsUtils (#1906 )

2020-08-10 17:54:03 +02:00

xsDeploy.md

…