github.com/jaylevin/jenkins-library@v1.230.4/documentation/mkdocs.yml (about)

     1  site_name: 'Project "Piper": Continuous Delivery for the SAP Ecosystem'
     2  nav:
     3      - 'Home': index.md
     4      - 'Getting Started With Project "Piper"' : guidedtour.md
     5      - 'Configuration': configuration.md
     6      - 'Infrastructure':
     7          - 'Overview': infrastructure/overview.md
     8          - 'Custom Jenkins Setup': infrastructure/customjenkins.md
     9          - 'Vault For Pipline Secrets': infrastructure/vault.md
    10          - 'Fixing docker rate limit': infrastructure/docker-rate-limit.md
    11      - 'Pipelines':
    12          - 'ABAP Environment pipeline':
    13              - 'Introduction': pipelines/abapEnvironment/introduction.md
    14              - 'Configuration': pipelines/abapEnvironment/configuration.md
    15              - 'Extensibility': pipelines/abapEnvironment/extensibility.md
    16              - 'Stages':
    17                - 'Initial Checks': pipelines/abapEnvironment/stages/initialChecks.md
    18                - 'Prepare System': pipelines/abapEnvironment/stages/prepareSystem.md
    19                - 'Clone Repositories': pipelines/abapEnvironment/stages/cloneRepositories.md
    20                - 'Test': pipelines/abapEnvironment/stages/test.md
    21                - 'Build': pipelines/abapEnvironment/stages/build.md
    22                - 'Integration Tests': pipelines/abapEnvironment/stages/integrationTest.md
    23                - 'Confirm': pipelines/abapEnvironment/stages/confirm.md
    24                - 'Publish': pipelines/abapEnvironment/stages/publish.md
    25                - 'Post': pipelines/abapEnvironment/stages/post.md
    26          - 'General purpose pipeline':
    27              - 'Introduction': stages/introduction.md
    28              - 'Examples': stages/examples.md
    29              - 'Stages':
    30                  - 'Init Stage': stages/init.md
    31                  - 'Pull-Request Voting Stage': stages/prvoting.md
    32                  - 'Build Stage': stages/build.md
    33                  - 'Additional Unit Test Stage': stages/additionalunittests.md
    34                  - 'Integration Stage': stages/integration.md
    35                  - 'Acceptance Stage': stages/acceptance.md
    36                  - 'Security Stage': stages/security.md
    37                  - 'Performance Stage': stages/performance.md
    38                  - 'Compliance': stages/compliance.md
    39                  - 'Confirm Stage': stages/confirm.md
    40                  - 'Promote Stage': stages/promote.md
    41                  - 'Release Stage': stages/release.md
    42      - 'Scenarios':
    43          - 'Build and Deploy Hybrid Applications with SAP Solution Manager': scenarios/changeManagement.md
    44          - 'Build and Deploy SAPUI5/SAP Fiori Applications on SAP Cloud Platform': scenarios/ui5-sap-cp/Readme.md
    45          - 'Build and Deploy SAP Cloud Application Programming Model Applications': scenarios/CAP_Scenario.md
    46          - 'Integrate SAP Cloud Transport Management Into Your CI/CD Pipeline': scenarios/TMS_Extension.md
    47          - 'Build and Deploy SAP Fiori Applications on SAP HANA Extended Application Services, Advanced Model': scenarios/xsa-deploy/Readme.md
    48          - 'Build an SAP Fiori Application and Attach It to a Transport Request on an ABAP System': scenarios/upload-to-transportrequest/Readme.md
    49          - 'Build and Publish Add-on Products on SAP BTP, ABAP Environment': scenarios/abapEnvironmentAddons.md
    50          - 'Continuous Testing on SAP BTP, ABAP Environment': scenarios/abapEnvironmentTest.md
    51          - 'Set up a Pipeline-Based ABAP Development and Testing Process Using Git-Enabled Change and Transport System': scenarios/gCTS_Scenario.md
    52      - Extensibility: extensibility.md
    53      - 'Library steps':
    54          - abapAddonAssemblyKitCheckCVs: steps/abapAddonAssemblyKitCheckCVs.md
    55          - abapAddonAssemblyKitCheckPV: steps/abapAddonAssemblyKitCheckPV.md
    56          - abapAddonAssemblyKitCreateTargetVector: steps/abapAddonAssemblyKitCreateTargetVector.md
    57          - abapAddonAssemblyKitPublishTargetVector: steps/abapAddonAssemblyKitPublishTargetVector.md
    58          - abapAddonAssemblyKitRegisterPackages: steps/abapAddonAssemblyKitRegisterPackages.md
    59          - abapAddonAssemblyKitReleasePackages: steps/abapAddonAssemblyKitReleasePackages.md
    60          - abapAddonAssemblyKitReserveNextPackages: steps/abapAddonAssemblyKitReserveNextPackages.md
    61          - abapEnvironmentBuild: steps/abapEnvironmentBuild.md
    62          - abapEnvironmentAssemblePackages: steps/abapEnvironmentAssemblePackages.md
    63          - abapEnvironmentAssembleConfirm: steps/abapEnvironmentAssembleConfirm.md
    64          - abapEnvironmentCheckoutBranch: steps/abapEnvironmentCheckoutBranch.md
    65          - abapEnvironmentCloneGitRepo: steps/abapEnvironmentCloneGitRepo.md
    66          - abapEnvironmentCreateSystem: steps/abapEnvironmentCreateSystem.md
    67          - abapEnvironmentCreateTag: steps/abapEnvironmentCreateTag.md
    68          - abapEnvironmentPullGitRepo: steps/abapEnvironmentPullGitRepo.md
    69          - abapEnvironmentPushATCSystemConfig: steps/abapEnvironmentPushATCSystemConfig.md
    70          - abapEnvironmentRunATCCheck: steps/abapEnvironmentRunATCCheck.md
    71          - abapEnvironmentRunAUnitTest: steps/abapEnvironmentRunAUnitTest.md
    72          - apiKeyValueMapDownload: steps/apiKeyValueMapDownload.md
    73          - apiKeyValueMapUpload: steps/apiKeyValueMapUpload.md
    74          - apiProxyDownload: steps/apiProxyDownload.md
    75          - apiProviderDownload: steps/apiProviderDownload.md
    76          - apiProviderUpload: steps/apiProviderUpload.md
    77          - apiProxyUpload: steps/apiProxyUpload.md
    78          - artifactPrepareVersion: steps/artifactPrepareVersion.md
    79          - awsS3Upload: steps/awsS3Upload.md
    80          - batsExecuteTests: steps/batsExecuteTests.md
    81          - buildExecute: steps/buildExecute.md
    82          - checkmarxExecuteScan: steps/checkmarxExecuteScan.md
    83          - checksPublishResults: steps/checksPublishResults.md
    84          - cfManifestSubstituteVariables: steps/cfManifestSubstituteVariables.md
    85          - cloudFoundryCreateService: steps/cloudFoundryCreateService.md
    86          - cloudFoundryCreateServiceKey: steps/cloudFoundryCreateServiceKey.md
    87          - cloudFoundryDeleteService: steps/cloudFoundryDeleteService.md
    88          - cloudFoundryDeploy: steps/cloudFoundryDeploy.md
    89          - cnbBuild: steps/cnbBuild.md
    90          - commonPipelineEnvironment: steps/commonPipelineEnvironment.md
    91          - containerExecuteStructureTests: steps/containerExecuteStructureTests.md
    92          - containerPushToRegistry: steps/containerPushToRegistry.md
    93          - debugReportArchive: steps/debugReportArchive.md
    94          - detectExecuteScan: steps/detectExecuteScan.md
    95          - dockerExecute: steps/dockerExecute.md
    96          - dockerExecuteOnKubernetes: steps/dockerExecuteOnKubernetes.md
    97          - dubExecute: steps/dubExecute.md
    98          - durationMeasure: steps/durationMeasure.md
    99          - fortifyExecuteScan: steps/fortifyExecuteScan.md
   100          - gatlingExecuteTests: steps/gatlingExecuteTests.md
   101          - gaugeExecuteTests: steps/gaugeExecuteTests.md
   102          - gctsCloneRepository: steps/gctsCloneRepository.md
   103          - gctsCreateRepository: steps/gctsCreateRepository.md
   104          - gctsDeploy: steps/gctsDeploy.md
   105          - gctsExecuteABAPQualityChecks: steps/gctsExecuteABAPQualityChecks.md
   106          - gctsRollback: steps/gctsRollback.md
   107          - githubCheckBranchProtection: steps/githubCheckBranchProtection.md
   108          - githubCommentIssue: steps/githubCommentIssue.md
   109          - githubCreateIssue: steps/githubCreateIssue.md
   110          - githubCreatePullRequest: steps/githubCreatePullRequest.md
   111          - githubPublishRelease: steps/githubPublishRelease.md
   112          - githubSetCommitStatus: steps/githubSetCommitStatus.md
   113          - gitopsUpdateDeployment: steps/gitopsUpdateDeployment.md
   114          - gradleExecuteBuild: steps/gradleExecuteBuild.md
   115          - hadolintExecute: steps/hadolintExecute.md
   116          - handlePipelineStepErrors: steps/handlePipelineStepErrors.md
   117          - healthExecuteCheck: steps/healthExecuteCheck.md
   118          - helmExecute: steps/helmExecute.md
   119          - influxWriteData: steps/influxWriteData.md
   120          - integrationArtifactDeploy: steps/integrationArtifactDeploy.md
   121          - integrationArtifactDownload: steps/integrationArtifactDownload.md
   122          - integrationArtifactGetMplStatus: steps/integrationArtifactGetMplStatus.md
   123          - integrationArtifactGetServiceEndpoint: steps/integrationArtifactGetServiceEndpoint.md
   124          - integrationArtifactResource: steps/integrationArtifactResource.md
   125          - integrationArtifactUnDeploy: steps/integrationArtifactUnDeploy.md
   126          - integrationArtifactUpdateConfiguration: steps/integrationArtifactUpdateConfiguration.md
   127          - integrationArtifactUpload: steps/integrationArtifactUpload.md
   128          - isChangeInDevelopment: steps/isChangeInDevelopment.md
   129          - jenkinsMaterializeLog: steps/jenkinsMaterializeLog.md
   130          - kanikoExecute: steps/kanikoExecute.md
   131          - karmaExecuteTests: steps/karmaExecuteTests.md
   132          - kubernetesDeploy: steps/kubernetesDeploy.md
   133          - mailSendNotification: steps/mailSendNotification.md
   134          - malwareExecuteScan: steps/malwareExecuteScan.md
   135          - mavenBuild: steps/mavenBuild.md
   136          - mavenExecute: steps/mavenExecute.md
   137          - mavenExecuteIntegration: steps/mavenExecuteIntegration.md
   138          - mavenExecuteStaticCodeChecks: steps/mavenExecuteStaticCodeChecks.md
   139          - mtaBuild: steps/mtaBuild.md
   140          - multicloudDeploy: steps/multicloudDeploy.md
   141          - neoDeploy: steps/neoDeploy.md
   142          - newmanExecute: steps/newmanExecute.md
   143          - nexusUpload: steps/nexusUpload.md
   144          - npmExecuteEndToEndTests: steps/npmExecuteEndToEndTests.md
   145          - npmExecuteLint: steps/npmExecuteLint.md
   146          - npmExecuteScripts: steps/npmExecuteScripts.md
   147          - pipelineExecute: steps/pipelineExecute.md
   148          - pipelineRestartSteps: steps/pipelineRestartSteps.md
   149          - pipelineStashFiles: steps/pipelineStashFiles.md
   150          - pipelineStashFilesAfterBuild: steps/pipelineStashFilesAfterBuild.md
   151          - pipelineStashFilesBeforeBuild: steps/pipelineStashFilesBeforeBuild.md
   152          - piperLoadGlobalExtensions: steps/piperLoadGlobalExtensions.md
   153          - piperPublishWarnings: steps/piperPublishWarnings.md
   154          - prepareDefaultValues: steps/prepareDefaultValues.md
   155          - protecodeExecuteScan: steps/protecodeExecuteScan.md
   156          - pythonBuild: steps/pythonBuild.md
   157          - seleniumExecuteTests: steps/seleniumExecuteTests.md
   158          - setupCommonPipelineEnvironment: steps/setupCommonPipelineEnvironment.md
   159          - shellExecute: steps/shellExecute.md
   160          - slackSendNotification: steps/slackSendNotification.md
   161          - snykExecute: steps/snykExecute.md
   162          - sonarExecuteScan: steps/sonarExecuteScan.md
   163          - spinnakerTriggerPipeline: steps/spinnakerTriggerPipeline.md
   164          - testsPublishResults: steps/testsPublishResults.md
   165          - tmsUpload: steps/tmsUpload.md
   166          - transportRequestDocIDFromGit: steps/transportRequestDocIDFromGit.md
   167          - transportRequestReqIDFromGit: steps/transportRequestReqIDFromGit.md
   168          - transportRequestUploadCTS: steps/transportRequestUploadCTS.md
   169          - transportRequestUploadRFC: steps/transportRequestUploadRFC.md
   170          - transportRequestUploadSOLMAN: steps/transportRequestUploadSOLMAN.md
   171          - uiVeri5ExecuteTests: steps/uiVeri5ExecuteTests.md
   172          - vaultRotateSecretId: steps/vaultRotateSecretId.md
   173          - whitesourceExecuteScan: steps/whitesourceExecuteScan.md
   174          - writeTemporaryCredentials: steps/writeTemporaryCredentials.md
   175          - xsDeploy: steps/xsDeploy.md
   176      - 'Library Steps (deprecated)':
   177          - artifactSetVersion: steps/artifactSetVersion.md
   178          - checkChangeInDevelopment: steps/checkChangeInDevelopment.md
   179          - npmExecute: steps/npmExecute.md
   180          - transportRequestCreate: steps/transportRequestCreate.md
   181          - transportRequestRelease:  steps/transportRequestRelease.md
   182          - transportRequestUploadFile: steps/transportRequestUploadFile.md
   183          - gctsExecuteABAPUnitTests: steps/gctsExecuteABAPUnitTests.md
   184      - 'Command line tool': cli/index.md
   185  
   186  theme:
   187      name: 'material'
   188      palette:
   189        primary: 'teal'
   190        accent: 'purple'
   191      logo: 'images/piper_400_white.png'
   192      favicon: 'images/favicon.ico'
   193  extra:
   194      font:
   195        text: 'Slabo 13px'
   196        code: 'Ubuntu Mono'
   197  markdown_extensions:
   198      - admonition
   199      - attr_list
   200      - codehilite:
   201          guess_lang: false
   202      - toc:
   203          permalink: true
   204      - footnotes
   205      - pymdownx.superfences
   206      - pymdownx.tabbed
   207      - pymdownx.details
   208  extra_css:
   209      - 'css/extra.css'
   210  edit_uri: edit/master/documentation/docs
   211  site_dir: docs-gen
   212  repo_url: https://github.com/SAP/jenkins-library