Update Issue activity

An activity that changes an issue in GitHub.


Update Issue activity

Configure the Update Issue 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 Update Issue activity onto your process.

    Drag Update Issue activity

General Configuration

Specifies the basic settings for the Update Issue 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

Update Issue Configuration

Specifies the information to change an issue in GitHub.

Figure: Update Issue Configuration screen

Update Issue 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 change an issue.
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 change an issue.

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?

Title

Function:
Specifies the updated title for the issue in GitHub.
Accepted Values:
One line of text (a string) that can have letters, numbers, spaces, and special characters.
Default Value:
None
Accepts Process Data Variables:
Yes

Assignee

Function:
Specifies the name of the user to assign the issue.
Accepted Values:
A user name in 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?

State

Function:
Specifies the status of the issue to change.
Accepted Values:
A status from the list.
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?

Milestone

Function:
Specifies the name of the milestone to track progress on groups of issues in a repository.
Accepted Values:
A milestone name from the list.

When you select the repository name in the Repository field, this field shows the milestone names associated with the repository.

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?

Labels

Function:
Specifies one or more labels that are used as metadata or categories for the issue.
Accepted Values:
One line of text (a string) that can have letters, numbers, spaces, and special characters.

The line of text represents one or more labels, separated by semicolons (;).

If the labels entered in this field do not exist in your GitHub environment, when this activity runs, the activity creates the labels and adds them to the issue.

Default Value:
None
Accepts Process Data Variables:
Yes
Example:
Label 1;Label 2

Description

Function:
Specifies a description for the GitHub issue.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No