Skip to Content

GitHub Pull Request activity

Introduction

A GitHub Pull Request activity, using its GitHub connection, creates, deletes, queries, or updates pull request data in GitHub and is intended to be used as a target to consume data in an operation.

Create a GitHub Pull Request activity

An instance of a GitHub Pull Request activity is created from a GitHub connection using its Pull Request activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing GitHub Pull Request activity can be edited from these locations:

Configure a GitHub Pull Request activity

Follow these steps to configure a GitHub Pull Request activity:

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify the operation. Each user interface element of this step is described below.

GitHub Pull Request activity configuration step 1

  • Name: Enter a name to identify the activity. The name must be unique for each GitHub Pull Request activity and must not contain forward slashes / or colons :.

  • Operation: Specify the operation to be used, one of Create Pull Request, or Update Pull Request, or Query Pull Request, or Delete Pull Request.

  • Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select an object

In this step, select an object. Each user interface element of this step is described below.

GitHub Pull Request activity configuration step 2

  • Select an Object: This section displays objects available in the GitHub endpoint.

    • Selected Object: The operation selected in the previous step is listed here.

    • Selected Sub-object: After an object is selected, it is listed here.

    • Search: Enter any column's value into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload objects from the GitHub endpoint. This may be useful if objects have been added to GitHub. This action refreshes all metadata used to build the table of objects displayed in the configuration.

    • Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the GitHub endpoint:

      • Name: The name of the object.

      • Description: The description of the object.

    Tip

    If the table does not populate with available objects, the GitHub connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

GitHub Pull Request activity configuration step 3

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The GitHub connector uses the GitHub REST API. Refer to the API documentation for information on the schema nodes and fields.

    The request and response data schemas consist of these nodes and fields:

    Request Schema Node/Field Description
    createRequest Node of the create request
    item Node of the item
    head The last commit in a currently checked out branch
    owner Repository owner
    issue GitHub issue associated with the pull request
    draft Boolean value for draft (true or false)
    repo Repository name
    maintainer_can_modify Boolean value if the repository maintainer can modify the pull request (true or false)
    title Pull request title
    body Pull request message body
    base The base branch
    Response Schema Node/Field Description
    createResponse Node of the create response
    item Node of the item
    issue_url URL for this pull request's issues
    _links Node of links
    comments Node of the comments
    href Hypertext reference to comments
    commits Node of commits
    href Hypertext reference to commits
    statuses Node of the status
  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the GitHub endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring a GitHub Pull Request activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

GitHub Pull Request activities can be used as a target with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.