For the complete documentation index, see llms.txt. This page is also available as Markdown.

GitHub Copilot

Learn how to configure and use the GitHub Copilot plugin to view usage insights in Harness Internal Developer Portal (IDP).

Overview

The Github Copilot plugin provides GitHub Copilot Enterprise insights directly within Harness IDP. It helps visualize Copilot usage metrics such as:

  • Suggestion acceptance rates

  • Language-wise usage distribution

  • Overall Copilot activity

These insights help engineering teams assess the adoption and effectiveness of GitHub Copilot across their services.

Plugin metadata

Field
Value

Created by

Backstage Community

Category

Developer Experience

Source

Type

Open-source plugin

Configuration

Application configuration YAML

copilot:
  schedule:
    frequency:
      hours: 2
    timeout:
      minutes: 2
    initialDelay:
      seconds: 15
  host: github.com # or github.myenterprise.com
  # organization: ${{COPILOT_ORG}}  # eg: githubOrg - GitHub organization name
  # enterprise: ${{COPILOT_ENT}}  # Optional - only if using GitHub Enterprise

Update the host, enterprise, and organization values to match your GitHub Copilot Enterprise setup.

The plugin pulls data using GitHub REST APIs and requires authorization via a token which depends on the Git Integration setup done at IDP under ConfigureGit Integrations page, make sure to use the same host as one that is configured in the Git integration

If you are using copilot.enterprise in GitHub Copilot plugin config, note that the Enterprise API for Copilot only works with a "classic PAT" (personal access token). This means you will need to configure a Git connector in IDP, under ConfigureGit Integrations in your Harness account, with authorization using a username and token.

Delegate proxy (optional)

Set up a delegate proxy if:

  • GitHub APIs are not directly accessible from Harness SaaS.

  • The GitHub token (secret) is not stored in the built-in Secret Manager.

Steps:

  1. Add the host (github.com) under Host URL or IP Address.

  2. Use a delegate with access to GitHub and your Secret Manager.

  3. Provide delegate selector tags if needed.

Use a single delegate tag for consistency.

Layout integration

This plugin exports:

  • ✅ 1 Page

  • ❌ 0 Cards

  • ❌ 0 Tabs

To add the page to the portal layout:

Since its not added by default, you need to update your layout config in ConfigureLayoutSidenav Layout manually, like so:

Annotations

  • No specific annotations are required.

Last updated

Was this helpful?