Github plug-in integration example#

Github plug-in integration example

To configure the Github plug-in integration, complete the following steps:

  1. In the Integration Name field, enter a name for the integration, such as "Git tutorial."

    Such as GitHub tutorial. Later, we use this name to associate the integration to our value stream.

  2. In the Url field, enter the URL for the GitHub project that you configured earlier .

    The URL is similar to this example, https://github.com/myGitHubID/myGitHubProject.

  3. In the Name field, enter the name of the GitHub repository.

    Using the example URL from the preceding step, the name is myGitHubProject.

  4. In the Owner field, enter the GitHub account that owns the repository.

    Using the example URL, the owner is myGitHubID.

  5. In the Token field, enter your Github personal access token to authenticate with the Github repository.

    In GitHub, to generate a personal access token, go to Settings>Developer settings>Personal access tokens then click Generate new token and select the scope repo which allows to access repositories.

  6. In the API URL field, enter the GitHub API URL.

    For enterprise Github account, use GitHub API URL https://example.com/api/v3.

    For public Github account, use GitHub API URL https://api.github.com.

  7. Click Add.

The integration is listed on the Integrations page. If the integration is successful, the Status field displays Online. If the status is not Online, use the View log option to troubleshoot the integration. You can increase the logging level in the integration configuration if you need more troubleshooting information.

Parent topic: Creating plug-in integrations