GitHub Packages

Overview

Heeler connects with GitHub Packages for analysis analysis of the package artifacts running in your environment. Heeler requires a GitHub Personal Access Token (PAT) with read:packages permission to authenticate with GitHub Packages.

Setup

1. Navigate to GitHub Developer Settings

   1. Go to GitHub and log in to your account.

   2. Click on your profile picture (top right) and select Settings.

   3. Scroll down and click on Developer settings (left sidebar).

   4. Click Personal access tokens → Tokens (classic).

   5. Click Generate new token (classic).

2. Configure the Personal Access Token

   1. Note: If prompted, enter your GitHub password or use two-factor authentication.

   2. In the Note field, enter a descriptive name (e.g., Heeler GitHub Packages).

   3. Expiration: Set an expiration date based on your security policies.

   4. Under Select scopes, check the following permission:

      1. ✅ read:packages (to allow Heeler to pull packages from GitHub Packages)

1. Generate and Save the Token

   1. Scroll down and click Generate token.

   2. Important: Copy and store the token securely. You won’t be able to see it again.

   3. Use this token when configuring Heeler to authenticate with GitHub Packages.

2. Configure Heeler to Connect to GitHub Packages

   1. Select the icon from the top navigation

   2. Select Connections -> Registries then select 'Add Registry'

   3. Select GitHub

   4. Fill the required values for the connection:

      1. Ensure Package is selected for the registry type

      2. Package Type - The package ecosystem for the artifacts Heeler should analyze. If multiple ecosystems are needed, each needs a separate GitHub Package connection. Maven and NPM ecosystems are supported.

      3. Name - Provide any name you wish for the connection

      4. Organization - Your GitHub organization name (slug), e.g. https://github.com/<your-org-name>

      5. Username - Paste username used to generate PAT from Step 3

      6. Repository - GitHub Package repository to connect

      7. Access Token - Paste your access token from Step 3

   5. Click 'Save'