Skip to main content
Version: Release 23.3

Github Plugin

This topic describes how to configure the Digital.ai Release Github plugin.

Prerequisites​

  • Install the Github plugin into the XLR plugins/xlr-official folder.

Requirements​

  • Github account
  • Github Enterprise running and accessible
  • Digital.ai Release running and accessible.

Configuration​

  • You need to have information about URL, username, and password, or access token with the proper permissions or by using client ID/client secret combination.
  • Create a Connections for your Github Server.

Set up a Connection to the Github Server​

  1. From the navigation pane, click Configuration > Connections.

  2. Under configurations, beside Github: Server, click Add button

  3. Enter the name for the configuration in the Title field.

  4. Enter the username in the Login field.

  5. Enter the login password or token in Password/Token field.

  6. Enter the URL in the field, where the Github is running (https://api.github.com or https://github.myorg.com/api/v3).

  7. Click on Test, to test the connection.

  8. Click on Save, to save the configuration.

    XLR_github_CONNECTION

Features​

  • Github triggers - This trigger can be used to poll the Github for triggering releases.

    • Github commit trigger.
    • Github Pull Request trigger.

  • Tasks of Github:

    • Github: Create Branch
    • Github: Create Pull Request
    • Github: Create Repository
    • Github: Create Tag
    • Github: Get Hash From Ref
    • Github: Get Version From Tag
    • Github: Merge Pull Request
    • Github: Update Content
    • Github: Wait For Merge

  • Tasks of Github Actions:

    • Github Actions: Enable Disable Workflow
    • Github Actions: Trigger Workflow Run

  • Github tile on the release dashboard.

Github Actions: Enable Disable Workflow​

  • Enable or disable a github actions workflow.

    Enable Github Actions workflow

Github Actions: Trigger Workflow Run​

  • Manually trigger a workflow run from Release.

    Trigger Github Actions workflow

Tile and Dashboard Configuration for Github Server​

There is one tile in Github server:

  • Github User Summary

  1. From the navigation pane, click Reports > Custom Dashboard.

  2. Select the dashboard where you want to add the new tile.

    note

    If you have not created a dashboard yet, click on Create custom dashboard on the top right of the screen to create dashboard.

  3. In the top right of the screen, click Configure dashboard > Add tiles.

  4. Select GitHub User Tile and click Add.

  5. Hover over Github User Summary, and click Configure option present in the tile.

  6. Enter a name for the tile in the Title field.

  7. Select the github configured in the Github Server field.

  8. Click Save.

    Github User Summary tile

Known Problems​

  • Github plugin doesn't work behind a proxy