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

To install the plug-in, perform the following steps:

1. In HCL DevOps Velocity, click Settings > Integrations > Available.
2. In the Action column for the GitHub plug-in, click Install.

There are two methods to integrate the plug-in:

• Using the user interface
• Using a JSON file

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

Integrating the plug-in by using user interface

To integrate the plug-in using the user interface, perform the following steps:

1. In HCL DevOps Velocity, click Settings > Integrations > Installed.
2. In the Action column for the GitHub plug-in, click Add Integration.
3. On the Add Integration dialog, enter the values for the fields to configure the integration and define communication.
4. Click Add.

Integrating the plug-in by using 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. Refer to the JSON sample code in the Configuration Properties section.

To integrate the plug-in using a JSON, perform the following steps:

1. Navigate to value stream page, and then click the necessary value stream.
2. Click  icon, and then Select Edit value stream to modify the JSON file in the code or tree view editors.
   Alternatively, you can also click Download JSON option to download the JSON file, and then select the Import JSON option to upload the revised JSON file.
3. Edit the integration information in the JSON file to add the plug-in configuration properties. Refer to JSON sample code in the Configuration Properties section more details.
4. Click Save.

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.

Previously: 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-*.

Summary

The GitHub plugin provides for integration with a GitHub server. This plugin imports issues, pull requests, and commit data from a GitHub server and saves them as HCL DevOps Velocity issues. Data between the GitHub server and the HCL DevOps Velocity server is synchronized every five minutes.

Compatibility

This plugin supports Cloud and On-Premises platform.

Upgrade notes

Beginning with HCL DevOps Velocity version 2.4.0 users must enter a user access key is required to connect with the HCL DevOps Velocity server. If you are upgrading from a previous version, you must obtain and add the key to the HCL DevOps Velocity User Access Key configuration property. If the user access key is not added, the integration fails.

History

The following table describes the changes made in each plugin version.

Overview

The GitHub Copilot Metrics integration enables customers to automatically collect and analyze Copilot usage insights for their organization. This feature retrieves user activity, engagement levels, language-specific completions, and other Copilot adoption metrics directly from the GitHub API and syncs them into Velocity.

This helps organizations track how developers are using AI-assisted coding and measure productivity impact through structured metrics.

Configuration Structure

The GitHub Copilot Metrics integration fetches structured JSON data from the Copilot Metrics API and extracts multiple metric categories. Velocity processes the API response and converts it into five different metric datasets.

User Adoption Metrics

These fields come directly from the API response:

dataset: GenAI User Adoption

Line Acceptance Metrics

These fields come directly from the API response:

dataset: GenAI Line Acceptance

Code Acceptance Metrics (Suggestion Acceptance)

These fields come directly from the API response:

dataset: GenAI Code Acceptance

Chat Events Metrics

These fields come directly from the API response:

dataset: GenAI Chat Events

Pull Request Summary Metrics

These fields come directly from the API response:

dataset: GenAI PR Events

Example Copilot Metric Record

    
{ 
  "date": "2025-06-11", 
  "total_active_users": 40, 
  "total_engaged_users": 20, 
  "copilot_ide_code_completions": { 
	"total_engaged_users": 20, 
	"languages": [ 
  	{ "name": "python", "total_engaged_users": 10 }, 
  	{ "name": "ruby", "total_engaged_users": 5 }, 
  	{ "name": "javascript", "total_engaged_users": 5 } 
	] 
  } 
} 
    

Explanation:

• date: Metric aggregated per day
• total_active_users: Anyone who used Copilot
• total_engaged_users: Anyone who engaged with Copilot suggestions
• languages: Breakdown of engaged users per programming language

Velocity collects and stores this data for reporting and trend analysis.

Pre-requisites

To use the GitHub Copilot Metrics integration, the following requirements must be met:

1. GitHub Organization Administrator Access

You must have organization-level admin access to enable and configure Copilot API usage.

2. Copilot API Access Approval

Your organization must request and obtain Copilot API access from GitHub. Without this approval, Copilot metrics cannot be collected.

3. Required Tokens

Personal Access Tokens must include Copilot Admin permissions. Tokens without these scopes will fail.

4. IT / Security Team Approval

Copilot Admin API permissions typically require approval from your IT or Security teams.

Authentication Requirements

Enable Collect Copilot Metrics in Add Integration

After Enabled, you need to fill the following details:

• Organization Name
• Team Slug
• Personal Access Token ( Copilot)

The following Copilot metrics can be added and displayed within the Velocity insights section:

• GenAI Line Acceptance
• GenAI User Adoption
• GenAI Chat Events
• GenAI Code Acceptance
• GenAI PR Events

Note:

This feature is provided as a Tech Preview. Organizations intending to enable this feature, must obtain GitHub Copilot API access approvals and generate tokens with the required Copilot permissions. Without these approvals and the appropriate tokens, Copilot metrics cannot be collected.