Github Enterprise Integration

Step 1 - Create a GitHub App on Your Enterprise Instance

To begin the integration, create a new GitHub App within your company’s GitHub Enterprise environment. This app enables secure, read-only access for GitMe to analyze repository data and track development activity.

Option 1: Manual Setup (Not Recommended)

• Log in to your GitHub Enterprise instance as an administrator.
• Go to Settings > Developer settings > GitHub Apps.
• Click “New GitHub App”.
• Fill in the required details (see below).
• Download your Private Key and note your App ID, Client ID, and Client Secret for integration with GitMe.

App Settings — Fill in the Fields as Follows:

• App name:
  GitMe Performance Tracking
• Homepage URL:
  https://www.gitdotme.com
• Description:
  AI-measured real developer effort, code retention, and contribution categories across your team
• Webhook URL:
  https://backend.gitdotme.com/github/webhook
• Callback URL (Authorization callback URL):
  https://backend.gitdotme.com/github/enterprise/callback?scope=user:email
• Public:
  Uncheck (leave as private)

Permissions

(Choose “Read-only” for each permission listed below.)

• Repository permissions:
  • Contents: Read-only
  • Metadata: Read-only (mandatory)
  • Commit statuses: Read-only
• Organization permissions:
  • Members: Read-only
• Account permissions:
  • Email addresses: Read-only

Events

• Leave blank (no events selected)

Option 2: Setup with Manifest (Recommended for Speed and Accuracy)

1. Create a file named manifest.json and copy the content provided below into it.
2. In your GitHub Enterprise instance, go to Settings > Developer settings > GitHub Apps.
3. Click “New GitHub App” and choose “Create from manifest”.
4. Paste the manifest content or upload the manifest file.
5. Review and confirm the details.
6. The app will be created automatically with all required permissions and URLs pre-filled.
7. Download your Private Key and note your App ID, Client ID, and Client Secret for integration with GitMe.

{
  "name": "GitMe Performance Tracking",
  "url": "https://www.gitdotme.com",
  "description": "AI-measured real developer effort, code retention, and contribution categories across your team",
  "hook_attributes": {
    "url": "https://backend.gitdotme.com/github/webhook"
  },
  "redirect_url": "https://backend.gitdotme.com/github/callback?scope=user:email",
  "public": false,
  "default_permissions": {
    "contents": "read",
    "metadata": "read",
    "statuses": "read",
    "members": "read",
    "emails": "read",
    "pull_requests": "read"
  },
  "default_events": []
}