Skip to content

Latest commit

 

History

History
138 lines (107 loc) · 4.31 KB

github-comment-v0.md

File metadata and controls

138 lines (107 loc) · 4.31 KB
Raw
title description ms.date monikerRange
GitHubComment@0 - GitHub Comment v0 task
Write a comment to your GitHub entity i.e. issue or a Pull Request (PR).
07/02/2024
>=azure-pipelines-2020

GitHubComment@0 - GitHub Comment v0 task

:::moniker range=">=azure-pipelines-2020"

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

:::moniker-end

Syntax

:::moniker range=">=azure-pipelines-2020"

# 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.

:::moniker-end

Inputs

:::moniker range=">=azure-pipelines-2020"

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.


:::moniker-end

:::moniker range=">=azure-pipelines-2020"

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

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


:::moniker-end

:::moniker range=">=azure-pipelines-2020"

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.


:::moniker-end

:::moniker range=">=azure-pipelines-2020"

comment - Comment
string.

The contents of the comment to be written.


:::moniker-end

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

:::moniker range=">=azure-pipelines-2020"

None.

:::moniker-end

Requirements

:::moniker range=">=azure-pipelines-2020"

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

:::moniker-end