GitHub

The GitHub connector Service used to define a connection required for associated actions and start events. Examples include Salesforce and Box. Method of integration to cloud services, business applications and content stores. is used to create connections for GitHub actions A tool for building the processes, logic, and direction within workflows.. Use GitHub actions to create Issues within GitHub. GitHub Issues are a way to track bugs, tasks, and enhancements in a project, and are like a message that is shared and can be actioned by development team members.

Create a GitHub connection

You can create connections from the Automate or Designer page.

Note: Your browser-stored credentials are accessed to create connections. Either clear credentials from browser memory or make sure the stored credentials are for the intended environment.

  • Nintex Workflow Cloud uses the Nintex Workflow Cloud - GitHub Connector to create GitHub connections. This connection requires you to grant the Nintex Workflow Cloud domain access to certain GitHub data.
  • The account you use to create a connection for GitHub is the account that has access to the GitHub actions.

  1. On the top navigation bar, click Automate, and then select Connections from the left navigation.

  2. On the Connections page, click Add new.

  3. In the Add a new connection section that opens, fill in the following.

    In this field

    Select or enter the following
    Connector GitHub

  4. Click Connect.

  5. In the Configure a connection window, fill in the fields as follows.

    In this field

    Select or enter the following
    Connection name A name for your new connection

  6. Click Connect.

  7. Follow the prompts to enter credentials and grant access to Nintex Workflow Cloud.

  8. In the permissions dialog, you can do one of the following:
    • Edit the Owners or Users permissions according to data source usage requirements and click Save permissions.

      • Tip: You can assign connection owners or users permissions according to your access requirements. For more information, see Permissions.

Your new connection appears on the Connections page.

    • On the top navigation bar, click Automate > Workflows, and then select the required workflow.

      • (Or)

    • On the top navigation bar, click Automate > Create workflow.
  2. Click the GitHub action you want to add the connection to, or drag a GitHub action into the workflow and select it.

  3. In the drop-down list for Connection, select Add new connection.

  4. In the Connection window, fill in the fields as follows.

    In this field

    Select or enter the following
    Connection name A name for your new connection

  5. Click Connect.

  6. Follow the prompts to enter credentials and grant access to Nintex Workflow Cloud.

  7. In the permissions dialog, you can do one of the following:
    • Edit the Owners or Users permissions according to data source usage requirements and click Save permissions.

      • Tip: You can assign connection owners or users permissions according to your access requirements. For more information, see Permissions.

Your new connection appears in the Connection field of your action.

Permissions

Permissions enable you to manage access for other users to use, edit, and delete connections.

  Use

Edit

 Delete

Assign
permissions

Owners
Users

Note: By default, users with administrator role will have the same rights as a Connection owner.

Follow these steps to assign permissions from the Connections page:

  1. On the Connections page, click for the required connection.
  2. From the menu, select Permissions.

    3. The corresponding permissions window is displayed.

  3. To assign permissions:
    • In the Owners field, type the name of the user, and select from the list.
    • In the Users field, type the name of the user, and select from the list.
  1. Click Save permissions.

Create a GitHub data source

Use the GitHub data source to create a drop-down in a form showing a list of GitHub repositories for the user account used to create the connector.

Example:  To allow users to select a specific repository in a form, add a drop-down list of repositories to the form using a Data lookup control A form control that allows users to select from a drop-down list of values that have been fetched from a third-party service.. The data lookup control uses a GitHub - Get authenticated user repos data source to list the repositories associated with the authenticated user.

Each data source is configured for a specific GitHub user. You can create as many data sources as you need.

To add a GitHub drop-down list to your form:

  1. Create your GitHub data source.

    2. See Data sources.

  2. Add a data lookup form control to your form and configure it to use your new data source.

Assign data source permissions

Permissions enable you to manage access for other users to use, edit, and delete data sources.

  Use

Edit

 Delete

Assign
permissions

Connection owners

 ✔ ✔ ✔ ✔

Data source editors

 ✔ ✔ ✔ ✘
Data source users ✔ ✘ ✘ ✘

Note: By default, users with administrator role will have the same rights as a Connection owner.

Follow these steps to assign data source permissions from the Data sources page:

  1. On the Data sources page, click for the required data source.
  2. From the menu, select Permissions.

    3. The corresponding data source permissions window is displayed.

  3. To assign permissions:
    • In the Data source editors field, type the name of the user, and select from the list.
    • In the Data source users field, type the name of the user, and select from the list.
  1. Click Save Permissions.

GitHub data source fields

When you create a GitHub data source, you can configure some additional fields to specify which repository the data source should retrieve.

Section

Field or selection

Description
Add new data source Operation Displays the operations available for the selected Connector. The following fields are displayed:
  • Get authenticated user repos:
    • Sort by: Sort the returned list by either when the repo was created, updated, pushed, or by the repo's full name.
    • Sort direction: Sort the returned list in either ascending or descending order.