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

     1  metadata:
     2    name: githubCreatePullRequest
     3    description: Create a pull request on GitHub
     4    longDescription: |
     5      This step allows you to create a pull request on Github.
     6  
     7      It can for example be used for GitOps scenarios or for scenarios where you want to have a manual confirmation step which is delegated to a GitHub pull request.
     8  spec:
     9    inputs:
    10      secrets:
    11        - name: githubTokenCredentialsId
    12          description: Jenkins 'Secret text' credentials ID containing token to authenticate to GitHub.
    13          type: jenkins
    14      params:
    15        - name: assignees
    16          description: Login names of users to which the PR should be assigned to.
    17          scope:
    18            - PARAMETERS
    19            - STAGES
    20            - STEPS
    21          type: "[]string"
    22        - name: base
    23          description: The name of the branch you want the changes pulled into.
    24          scope:
    25            - PARAMETERS
    26            - STAGES
    27            - STEPS
    28          type: string
    29          mandatory: true
    30        - name: body
    31          description: The description text of the pull request in markdown format.
    32          scope:
    33            - PARAMETERS
    34            - STAGES
    35            - STEPS
    36          type: string
    37          mandatory: true
    38        - name: apiUrl
    39          aliases:
    40            - name: githubApiUrl
    41          description: Set the GitHub API url.
    42          scope:
    43            - GENERAL
    44            - PARAMETERS
    45            - STAGES
    46            - STEPS
    47          type: string
    48          default: https://api.github.com
    49          mandatory: true
    50        - name: head
    51          description: The name of the branch where your changes are implemented.
    52          scope:
    53            - PARAMETERS
    54            - STAGES
    55            - STEPS
    56          type: string
    57          mandatory: true
    58        - name: owner
    59          aliases:
    60            - name: githubOrg
    61          description: Name of the GitHub organization.
    62          resourceRef:
    63            - name: commonPipelineEnvironment
    64              param: github/owner
    65          scope:
    66            - PARAMETERS
    67            - STAGES
    68            - STEPS
    69          type: string
    70          mandatory: true
    71        - name: repository
    72          aliases:
    73            - name: githubRepo
    74          description: Name of the GitHub repository.
    75          resourceRef:
    76            - name: commonPipelineEnvironment
    77              param: github/repository
    78          scope:
    79            - PARAMETERS
    80            - STAGES
    81            - STEPS
    82          type: string
    83          mandatory: true
    84        - name: serverUrl
    85          aliases:
    86            - name: githubServerUrl
    87          description: GitHub server url for end-user access.
    88          scope:
    89            - GENERAL
    90            - PARAMETERS
    91            - STAGES
    92            - STEPS
    93          type: string
    94          default: https://github.com
    95          mandatory: true
    96        - name: title
    97          description: Title of the pull request.
    98          scope:
    99            - PARAMETERS
   100            - STAGES
   101            - STEPS
   102          type: string
   103          mandatory: true
   104        - name: token
   105          aliases:
   106            - name: githubToken
   107            - name: access_token
   108          description: GitHub personal access token as per https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
   109          scope:
   110            - GENERAL
   111            - PARAMETERS
   112            - STAGES
   113            - STEPS
   114          type: string
   115          mandatory: true
   116          secret: true
   117          resourceRef:
   118            - name: githubTokenCredentialsId
   119              type: secret
   120            - type: vaultSecret
   121              default: github
   122              name: githubVaultSecretName
   123        - name: labels
   124          description: Labels to be added to the pull request.
   125          scope:
   126            - PARAMETERS
   127            - STAGES
   128            - STEPS
   129          type: "[]string"