Create Issue Comment activity

An activity that creates a comment for an issue in GitHub.


Create Issue Comment activity

Configure the Create Issue Comment activity

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the GitHub tab.

    Open GitHub tab
  3. On the GitHub tab, drag the Create Issue Comment activity onto your process.

    Drag Create Issue Comment activity

General Configuration

Specifies the basic settings for the Create Issue Comment activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Create Issue Comment Configuration

Specifies the information to create a comment in the GitHub issue.

Figure: Create Issue Comment Configuration screen

Create Issue Comment Configuration screen

Fields

Field NameDefinition

GitHub

Function:
Specifies the access token that connects to your GitHub service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for GitHub
Function of this Screen:
Configure an access token to connect to GitHub.

Repository

Function:
Specifies the name of the repository in which to add the comment.
Accepted Values:
A repository name from the list.

When you select the access token from the GitHub field, this field shows the repository names associated with the access token.

Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Issue Number

Function:
Specifies the number for the issue to which to add a comment.

The issue number comes from GitHub.

Accepted Values:
An issue number from GitHub.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Comment

Function:
Specifies a comment to associate with the issue.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
Yes

Store Response Comment ID In This Variable

Function:
Specifies the process data variable to store the ID of the issue comment.

The comment ID comes from GitHub.

Accepted Values:
A process data variable that accepts a numeric string with no spaces or special characters.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?