Edit

GitHubComment@0 - GitHub Comment v0 task

  • Article

Use this task to write a comment to your GitHub entity, for example an issue or a Pull Request (PR).

Syntax

# GitHub Comment v0
# Write a comment to your GitHub entity i.e. issue or a pull request (PR).
- task: GitHubComment@0
  inputs:
    gitHubConnection: # string. Required. GitHub connection (OAuth or PAT). 
    repositoryName: '$(Build.Repository.Name)' # string. Required. Repository. Default: $(Build.Repository.Name).
    #id: # string. ID of the github pr/issue. 
    #comment: # string. Comment.

Inputs

gitHubConnection - GitHub connection (OAuth or PAT)
string. Required.

Specifies the name of the GitHub service connection to use to connect to the GitHub repository. The connection must be based on a GitHub user's OAuth or a GitHub personal access token. For more information about service connections, see Manage service connections.


repositoryName - Repository
string. Required. Default value: $(Build.Repository.Name).

Specifies the name of the GitHub repository where the GitHub comment will be created.


id - ID of the github pr/issue
string.

Specifies the issue or PR number. If used in a PR pipeline, leave this field empty to dynamically figure out the ID.


comment - Comment
string.

The contents of the comment to be written.


Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Requirements

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version 2.0.0 or greater
Task category Utility