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

     1  metadata:
     2    name: githubCreateIssue
     3    description: Create a new GitHub issue.
     4    longDescription: |
     5      This step allows you to create a new GitHub issue.
     6  
     7      You will be able to use this step for example for regular jobs to report into your repository in case of new security findings.
     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: apiUrl
    16          aliases:
    17            - name: githubApiUrl
    18          description: Set the GitHub API url.
    19          scope:
    20            - GENERAL
    21            - PARAMETERS
    22            - STAGES
    23            - STEPS
    24          type: string
    25          default: https://api.github.com
    26          mandatory: true
    27        - name: assignees
    28          description: Defines the assignees for the Issue.
    29          scope:
    30            - PARAMETERS
    31            - STAGES
    32            - STEPS
    33          type: "[]string"
    34          default: []
    35          mandatory: false
    36        - name: body
    37          description: Defines the content of the issue, e.g. using markdown syntax.
    38          scope:
    39            - PARAMETERS
    40            - STAGES
    41            - STEPS
    42          type: string
    43        - name: bodyFilePath
    44          description: Defines the path to a file containing the markdown content for the issue. This can be used instead of [`body`](#body)
    45          scope:
    46            - PARAMETERS
    47            - STAGES
    48            - STEPS
    49          type: string
    50        - name: owner
    51          aliases:
    52            - name: githubOrg
    53          description: Name of the GitHub organization.
    54          resourceRef:
    55            - name: commonPipelineEnvironment
    56              param: github/owner
    57          scope:
    58            - PARAMETERS
    59            - STAGES
    60            - STEPS
    61          type: string
    62          mandatory: true
    63        - name: repository
    64          aliases:
    65            - name: githubRepo
    66          description: Name of the GitHub repository.
    67          resourceRef:
    68            - name: commonPipelineEnvironment
    69              param: github/repository
    70          scope:
    71            - PARAMETERS
    72            - STAGES
    73            - STEPS
    74          type: string
    75          mandatory: true
    76        - name: title
    77          description: Defines the title for the Issue.
    78          scope:
    79            - PARAMETERS
    80            - STAGES
    81            - STEPS
    82          type: string
    83          mandatory: true
    84        - name: updateExisting
    85          description: Whether to update an existing open issue with the same title by adding a comment instead of creating a new one.
    86          scope:
    87            - PARAMETERS
    88            - STAGES
    89            - STEPS
    90          type: bool
    91          mandatory: false
    92          default: false
    93        - name: token
    94          aliases:
    95            - name: githubToken
    96            - name: access_token
    97          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.
    98          scope:
    99            - GENERAL
   100            - PARAMETERS
   101            - STAGES
   102            - STEPS
   103          type: string
   104          mandatory: true
   105          secret: true
   106          resourceRef:
   107            - name: githubTokenCredentialsId
   108              type: secret
   109            - type: vaultSecret
   110              default: github
   111              name: githubVaultSecretName