github.com/jaylevin/jenkins-library@v1.230.4/resources/metadata/shellExecute.yaml (about)

     1  metadata:
     2    name: shellExecute
     3    description: Step executes defined script
     4    longDescription: Step executes defined script provided in the 'sources' parameter
     5  spec:
     6    inputs:
     7      secrets:
     8        - name: githubTokenCredentialsId
     9          description: Jenkins credentials ID containing the github token.
    10          type: jenkins
    11      params:
    12        - name: sources
    13          type: "[]string"
    14          scope:
    15            - PARAMETERS
    16            - STAGES
    17            - STEPS
    18          description: Scripts paths that must be present in the current workspace or https links to scripts.
    19              Only https urls from github are allowed and must be in the format :https://{githubBaseurl}/api/v3/repos/{owner}/{repository}/contents/{path to script}
    20              Authentication for the download is only supported via the 'githubToken' param. Make sure the script has the necessary execute permissions.
    21        - name: githubToken
    22          description: "GitHub personal access token as per
    23            https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line"
    24          scope:
    25            - GENERAL
    26            - PARAMETERS
    27            - STAGES
    28            - STEPS
    29          type: string
    30          secret: true
    31          aliases:
    32            - name: access_token
    33          resourceRef:
    34            - name: githubTokenCredentialsId
    35              type: secret
    36            - type: vaultSecret
    37              default: github
    38              name: githubVaultSecretName
    39        - name: scriptArguments
    40          type: "[]string"
    41          scope:
    42            - PARAMETERS
    43            - STAGES
    44            - STEPS
    45          description: scriptArguments that are needed to be passed to scripts. the scriptArguments list is a flat list and has a positional relationship to the `sources` param.
    46            For e.g. The scriptArguments string at position 1 will be considered as the argument(s) for script at position 1 in `sources` list
    47          mandatory: false
    48    containers:
    49      - name: shell
    50        image: node:lts-stretch
    51        workingDir: /home/node