docs: replace non-existent Docker image with build instructions#1189
Merged
Conversation
…d instructions There is no official pre-built Docker image for the Copilot CLI. Update docs to provide a sample Dockerfile that builds from GitHub releases, along with build/push commands. Local examples use copilot-cli:latest, remote deployment examples (K8s, ACI) use your-registry/copilot-cli:latest. Fixes #897 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the backend deployment/scaling documentation to remove references to a non-existent ghcr.io/github/copilot-cli image and replace them with “build your own image” guidance, so users can reliably containerize and deploy the Copilot CLI in headless mode.
Changes:
- Adds a note and sample
Dockerfilefor building the Copilot CLI image from GitHub releases, plus build/tag/push commands. - Updates local container examples (Docker run, Docker Compose) to use
copilot-cli:latest. - Updates remote deployment examples (Kubernetes, ACI) to use
your-registry/copilot-cli:latest.
Show a summary per file
| File | Description |
|---|---|
| docs/setup/backend-services.md | Adds “no official image” note + sample Dockerfile/build instructions; updates Docker/Docker Compose examples to use a locally built copilot-cli:latest image. |
| docs/setup/scaling.md | Replaces the non-existent GHCR image reference with your-registry/copilot-cli:latest in scaling/deployment examples. |
Copilot's findings
- Files reviewed: 2/2 changed files
- Comments generated: 2
| - name: copilot-cli | ||
| image: ghcr.io/github/copilot-cli:latest | ||
| image: your-registry/copilot-cli:latest # See backend-services.md for how to build and push this image | ||
| command: ["copilot", "--headless", "--host", "0.0.0.0", "--port", "4321"] |
| # Docker — must bind to 0.0.0.0 so the container's published port is reachable | ||
| docker run -d --name copilot-cli \ | ||
| -p 4321:4321 \ | ||
| -e COPILOT_GITHUB_TOKEN="$TOKEN" \ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
There is no official pre-built Docker image at
ghcr.io/github/copilot-cli. The docs referenced it in 4 places across 2 files, causing confusion for users trying to containerize the CLI.Changes
backend-services.mdexplaining there is no official imageDockerfilethat builds from GitHub releases usingdebian:bookworm-slimdocker build/docker tag/docker pushcommandsdocker run, Docker Compose) to usecopilot-cli:latestyour-registry/copilot-cli:latestFixes #897