GitHub: Look up an issue

Use this action to gather information about a GitHub issue by the issue number.

Use case

• Collecting and delivering issue information
• Sharing information with people without a GitHub account
• Creating a data table of issue information

How to configure this action

This action requires a preconfigured GitHub integration and an account with GitHub. For more information on integrating PagerDuty Workflow Automation with other systems, please refer to the Integrations section of our help center.

Fields for this action

• Integration

  • Select your GitHub integration from the options. These are your team’s integration accounts

• Repository owner

  • The name of the organization or owner of the repository that contains the issue.
  • The repository owner is part of the issue’s URL https://github.com/{repository owner}/{repository}/issues/{issue number}

• Repository

  • The name of the repository that contains the issue.
  • The repository is part of the issue’s URL https://github.com/{repository owner}/{repository}/issues/{issue number}

• Issue number

  • The number of the issue.
  • The issue number is part of the issue’s URL https://github.com/{repository owner}/{repository}/issues/{issue number}

• Output Field Prefix

  • To help keep output fields organized, choose an output field prefix to add to the beginning of each output field name as this action may output more than one field.
• The step’s name is used as the prefix by default.

What will this output?

This action returns different fields for each attribute of the GitHub issue found, such as the body text, title, or created date of the issue. The first fields listed below are the most relevant or commonly used fields. The section that follows, Output fields for GitHub’s REST API, lists less commonly used fields, such as URLs relevant to GitHub’s REST API.

For all fields, where the output field starts with user--, the fields contain information on the user who created the issue.

This action may generate multiple fields. To help keep output fields organized, the prefix above will be added to the beginning of each of the output field names, separated by two dashes. Each field will result as:{{output-field-prefix--output-field}}. Learn more

Output fields for this action

• integration

  • The integration selected during configuration.

• assignee

  • The username of the first assignee.

• assignees

  • If there are more than 1 assignee, this is the data table ID for the table containing a list of all assignees.

• author_association

  • The author’s association, such as collaborator.

• title

  • The title of the GitHub issue.

• body

  • The body of the issue in Markdown format.

• closed_at

  • If the issue is closed, the date and time it was closed. The date time is in standard YYYY-MM-DDThh:mm:ss.sTZD format.

• closed_by

  • If the issue is closed, the user who closed it.

• comments

  • The number of comments on the issue

• created_at

  • The date and time the issue was created. The date time is in standard YYYY-MM-DDThh:mm:ss.sTZD format.

• html_url

  • The standard URL to the issue on GitHub.

• id

  • The issue ID.

• labels

  • The data table ID for the table containing a list of all labels.

• user–login

  • The username of the user who created the issue.

• user–type

  • The status of the user, such as User or Admin.

• user–login

  • The username for the user who created the issue.

• user–html_url

  • The URL for the profile of the user who created the issue.

• locked

  • True or False for whether the issue is locked.

• milestone

  • The name of the milestone the issue is associated with. If there is no milestone, the field will be blank.

• number

  • The issue number. This can be found in the issue URL.

• state

  • The state of the issue, such as open or closed.

• updated_at

  • The date and time the issue was last updated. The date time is in standard YYYY-MM-DDThh:mm:ss.sTZD format.

Output fields for GitHub’s REST API

The remaining fields are all output fields containing request URLs for GitHub’s REST API, node IDs for different objects, or information less commonly used. Where the output field starts with user--, the fields contain information on the user who created the issue.

• statusCode
• node_id
• repository_url
• url
• events_url
• comments_url
• labels_url
• user---id
• user--avatar_url
• user--events_url
• user--followers_url
• user--following_url
• user--gravatar_id
• user--site_admin
• user--node_id
• user--organizations_url
• user--events_url
• user--repos_url
• user--starred_url
• user--subscriptions_url
• user--url