github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/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: chunkSize
    37          description: Defines size of the chunk. If content exceed chunk size it'll be sliced into chunks and stored in comments
    38          scope:
    39            - PARAMETERS
    40            - STAGES
    41            - STEPS
    42          type: int
    43          default: 65500
    44        - name: body
    45          description: Defines the content of the issue, e.g. using markdown syntax.
    46          scope:
    47            - PARAMETERS
    48            - STAGES
    49            - STEPS
    50          type: string
    51        - name: bodyFilePath
    52          description: Defines the path to a file containing the markdown content for the issue. This can be used instead of [`body`](#body)
    53          scope:
    54            - PARAMETERS
    55            - STAGES
    56            - STEPS
    57          type: string
    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: title
    85          description: Defines the title for the Issue.
    86          scope:
    87            - PARAMETERS
    88            - STAGES
    89            - STEPS
    90          type: string
    91          mandatory: true
    92        - name: updateExisting
    93          description: Whether to update an existing open issue with the same title by adding a comment instead of creating a new one.
    94          scope:
    95            - PARAMETERS
    96            - STAGES
    97            - STEPS
    98          type: bool
    99          mandatory: false
   100          default: false
   101        - name: token
   102          aliases:
   103            - name: githubToken
   104            - name: access_token
   105          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.
   106          scope:
   107            - GENERAL
   108            - PARAMETERS
   109            - STAGES
   110            - STEPS
   111          type: string
   112          mandatory: true
   113          secret: true
   114          resourceRef:
   115            - name: githubTokenCredentialsId
   116              type: secret
   117            - type: vaultSecret
   118              default: github
   119              name: githubVaultSecretName