Skip to content

[docs] Documentation update needed for push to main by @gkaleta #86

@github-actions

Description

@github-actions

Summary

Commit 3330548 (merge of PR #70Fix GitHub Enterprise host handling) introduced a new user-facing environment variable to doctor.sh that is not documented anywhere.


Code Change

File modified: doctor.sh
Lines added (6) / removed (2):

# Variable for the GitHub host, defaults to 'github.com'
GITHUB_HOST="\$\{GITHUB_HOST:-github.com}"
GITHUB_HOST="\$\{GITHUB_HOST#https://}"
GITHUB_HOST="\$\{GITHUB_HOST#(redacted)

The variable is subsequently used in two places:

  • PAT creation URL: https://\$\{GITHUB_HOST}/settings/tokens
  • Copilot CLI login: copilot login --host "https://\$\{GITHUB_HOST}"

Documentation Gap

No existing documentation (README.md, docs/, .devcontainer/README.md, CHANGELOG.md) mentions:

  • The GITHUB_HOST environment variable
  • Support for GitHub Enterprise Server (GHE)
  • How to configure the tool when using a GHE instance instead of github.com

Suggested Updates

1. README.md — AI Providers / Prerequisites table

Add a note in the GitHub Copilot or Prerequisites section explaining GitHub Enterprise Server support:

GitHub Enterprise Server: Set GITHUB_HOST=your-ghe-hostname (without https://) before running doctor.sh. The script defaults to github.com.

Or add a dedicated row/note to the supported providers table (around line 58):

Provider ... Notes
GitHub Copilot ... Supports GitHub Enterprise Server via GITHUB_HOST env var

2. README.mddoctor.sh environment variables or configuration section

If there is already a section listing environment variables (e.g., around lines 258–1013), add:

Variable Default Description
GITHUB_HOST github.com GitHub hostname for PAT URL and Copilot CLI login. Set to your GHE hostname (without scheme) when using GitHub Enterprise Server.

3. CHANGELOG.md

Add an entry for this fix:

### Fixed
- `doctor.sh``GITHUB_HOST` environment variable now configures the GitHub hostname for PAT URLs and Copilot CLI login, enabling GitHub Enterprise Server support. Defaults to `github.com`. Scheme prefixes (`https://`, `(redacted) are automatically stripped to prevent double-scheme errors.

Files to Update

File Section Change needed
README.md Prerequisites / Supported AI Providers / Environment variables Document GITHUB_HOST and GHE support
CHANGELOG.md Latest version or [Unreleased] Add fix entry for GITHUB_HOST / GHE support

Generated by Documentation Updater

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions