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

     1  metadata:
     2    name: githubCommentIssue
     3    description: Comment on GitHub issues and pull requests.
     4    longDescription: |
     5      This step allows you to add comments to existing GitHub issues or pull requests.
     6  
     7      Pull requests are considered similar to issues and thus adding a comment can be done to an existing pull request as well.
     8      This comes in very handy when you want to make developers aware of certain things during a PR voting process, for example.
     9  spec:
    10    inputs:
    11      secrets:
    12        - name: githubTokenCredentialsId
    13          description: Jenkins 'Secret text' credentials ID containing token to authenticate to GitHub.
    14          type: jenkins
    15      params:
    16        - name: apiUrl
    17          aliases:
    18            - name: githubApiUrl
    19          description: Set the GitHub API url.
    20          scope:
    21            - GENERAL
    22            - PARAMETERS
    23            - STAGES
    24            - STEPS
    25          type: string
    26          default: https://api.github.com
    27          mandatory: true
    28        - name: body
    29          description: Defines the content of the comment, e.g. using markdown syntax.
    30          scope:
    31            - PARAMETERS
    32            - STAGES
    33            - STEPS
    34          type: string
    35          mandatory: true
    36        - name: number
    37          description: Defines the number of the GitHub issue/pull request.
    38          scope:
    39            - PARAMETERS
    40            - STAGES
    41            - STEPS
    42          type: int
    43          mandatory: true
    44        - name: owner
    45          aliases:
    46            - name: githubOrg
    47          description: Name of the GitHub organization.
    48          resourceRef:
    49            - name: commonPipelineEnvironment
    50              param: github/owner
    51          scope:
    52            - PARAMETERS
    53            - STAGES
    54            - STEPS
    55          type: string
    56          mandatory: true
    57        - name: repository
    58          aliases:
    59            - name: githubRepo
    60          description: Name of the GitHub repository.
    61          resourceRef:
    62            - name: commonPipelineEnvironment
    63              param: github/repository
    64          scope:
    65            - PARAMETERS
    66            - STAGES
    67            - STEPS
    68          type: string
    69          mandatory: true
    70        - name: token
    71          aliases:
    72            - name: githubToken
    73            - name: access_token
    74          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.
    75          scope:
    76            - GENERAL
    77            - PARAMETERS
    78            - STAGES
    79            - STEPS
    80          type: string
    81          mandatory: true
    82          secret: true
    83          resourceRef:
    84            - name: githubTokenCredentialsId
    85              type: secret
    86            - type: vaultSecret
    87              default: github
    88              name: githubVaultSecretName