List pull requests action in GitHub package

The List Pull Requests action retrieves all pull requests from a GitHub repository. You can specify filters such as pull request state, target repository name and base repository name.

Overview

The List Pull Requests action retrieves data such as the pull request ID, number, state, title, user, description, source branch, target branch, created date, updated date, closed date, merged date, HTML URL, and issue URL.

Note: Ensure that the Connect action is configured before proceeding with the List issues as the Connect action provides the authentication context for the automation session.

Settings

The List Pull Requests action contains the following settings:

Note: All the input fields support string variables. You can create a string variable to hold the appropriate text string and select it in the applicable settings.
Session name
Specifies the GitHub session name that the Connect action creates. Use one of the following options to specify the session name:
  • Session name: Enter the session name as text directly or select the string variable that holds the session name text.
  • Variable: Select the GitHub session variable that the Connect action creates.
Owner name
Specifies the name of the GitHub repository owner. The owner can be an organization or a user account.
Repository name
Specifies the name of the GitHub repository from which the action retrieves the pull requests.
State
Specifies the state of the pull requests to retrieve. Select one of the following options:
  • Open: Select to retrieve all open pull requests. This is the default selection.
  • Closed: Select to retrieve all closed pull requests.
  • All: Select to retrieve all pull requests regardless of their state.
Target branch name (optional)
Specifies the name of the target branch to filter the pull requests. The action retrieves only the pull requests that target the branch specified in this field.
Source branch name (optional)
Specifies the name of the source branch to filter the pull requests. The action retrieves only the pull requests created from the branch specified in this field.
Assign output to variable
Specifies the table variable in which the action stores the response data. The response data includes the following fields:
  • id - The unique identifier of the pull request.
  • pullRequestNo - The unique identifier of the pull request within the repository.
  • state - The state of the pull request. The state can be open or closed.
  • title - The title of the pull request.
  • user - The user who created the pull request.
  • body - The body text of the pull request
  • baseRef - The target branch into which the pull request must be merged.
  • headRef - The source branch from which the pull request is created.
  • createdAt - The timestamp indicating when the pull request was created.
  • updatedAt - The timestamp indicating when the pull request was last updated.
  • closedAt - The timestamp indicating when the pull request was closed.
  • mergedAt - The timestamp indicating when the pull request was merged to the target branch.
  • htmlURL - The HTML URL of the pull request for direct access.
  • issueURL - The API URL of the pull request.