Usage

To use the GitHub plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. You define configuration properties in the user interface or in a JSON file.

Integration type

The GitHub plugin supports scheduled events integration which are listed in the following table.

Integration

There are two methods to integrate the plugin:

• Using the user interface
• Using a JSON file

The tables in the Configuration properties topic describe the properties used to define the integration.

Using the user interface

1. From the Plugins page, click Settings > Integrations > Plugins.
2. Under the Action column for the plugin, click Add Integration.
3. On the Add Integration page enter values for the fields used to configure the integration and define communication.
4. Click Save.

Using a JSON file

The JSON file contains the information for creating a value stream. Within the JSON file is a section for integrations. It is in this section that plugin properties can be defined.

1. From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
2. Edit the JSON file to include the plugin configuration properties.
3. Save and upload the JSON file. This replaces the current JSON file with the new content.
4. View the new integration on the Integrations page.

Minimum permission to integrate with GitHub

The access token generated from GitHub server requires the Full control of private repositories permission to connect to the Github.

Wildcard Functionality added in this Plugin:

Wildcard functionality: A new way to specify multiple repositories in the GitHub plugin without having to manually modify the integration each time. Regular expressions would be most valuable and dynamic. Example: ucv-ext-*, repo-name*, *repo*-abc. to specify multiple repositories which containe the same pattern in their name.

Previouly: Must list every plugin manually to be imported. Example: ucv-ext-jira, ucv-ext-appscan, ucv-ext-sonarqube
With this functionality : Single regex will import all repositories. Example: ucv-ext-*.

Configuration Properties

The following tables describe the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.

• The General Configuration Properties table describes configuration properties used by all plugin integrations.
• The GitHub Configuration Properties table describes the GitHub configuration properties that define the connection and communications with the GitHub server.

Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.

JSON code sample

The following sample code can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file Integration section and make the appropriate changes.

 "integrations":[
   {
      "type":"ucv-ext-github",
      "tenant_id":"tenant-id",
      "name":"github-integration-name",
      "properties":{
         "owner":"owner-name",
         "repositories":[
            "repo1",
            "repo2",
            "repo3"
         ],
         "apiUrl":"github-api-url",
         "token":"generated-token",
         "ucvAccessKey":"generated-access-key",
         "proxyServer": "proxy_server_url",
         "proxyUsername": "proxy_server_user_name",
         "proxyPassword": "proxy_server_password"
      }
   }
]