Home

GitHub

Prerequisites#

Available Actions#

  • Add to team
  • Check if repo exists
  • Comment on pull request
  • Create branch
  • Create issue
  • Create PR
  • Create release
  • Create repo
  • Get file
  • Get org
  • List commits
  • Merge pull request
  • Select pull request
  • Select team
  • Team names to IDs
  • Wait for PR to be mergeable
  • Wait for PR to be merged

Setting Up the Connector#

  1. In the Service Group Settings, select the Keys tab, click Add key, and search for GitHub. Click Create a key, specify a key name, select the global preset so that you do not need to define your own OAuth credentials, and click Save.

    Optionally, create your own OAuth credentials on the GitHub site, configure these as a new connector in Transposit, and then choose the configured connector above.

  2. In the Keys page, where your key is now listed, click Authenticate.

  3. The browser opens, letting you log in to your GitHub account.

GitHub is now enabled to interact with Transposit.

Trying Out the Connector#

To verify that the connector is set up correctly, do the following.

  1. Add a new action in a script.

  2. Search for the actions related to GitHub, select the one you need, and click Add.

  3. Fill out the inputs.

  4. Assign the key that you created earlier.

  5. Run the script and take note of the output in Transposit.