Skip to content

README.md

Latest commit

 

History

History
96 lines (68 loc) · 2.77 KB

README.md

File metadata and controls

96 lines (68 loc) · 2.77 KB

GitHub Development Environment (github-dev)

Installs the GitHub CLI (gh) and adds the essential GitHub VS Code extensions (Copilot, Copilot Chat, Pull Requests & Issues, GitHub Actions, RemoteHub). Automatically authenticates gh if a token is available in the environment.

Usage

{
    "features": {
        "ghcr.io/helpers4/devcontainer/github-dev:1": {}
    }
}

Combine with essential-dev for a complete development environment:

{
    "features": {
        "ghcr.io/helpers4/devcontainer/essential-dev:1": {},
        "ghcr.io/helpers4/devcontainer/github-dev:1": {}
    }
}

Options

Option Type Default Description
ghVersion string latest GitHub CLI version to install (e.g. 2.50.0 or latest)

What Gets Installed

GitHub CLI (gh)

Installed from GitHub Releases. Supports x86_64, aarch64, and armv7l.

Common uses inside the devcontainer:

gh auth status              # Check authentication
gh pr list                  # List open PRs
gh pr create                # Create a PR from current branch
gh pr checkout 123          # Check out a PR locally
gh issue list               # List issues
gh run list                 # List workflow runs
gh run watch                # Watch a running workflow
gh release create v1.0.0    # Create a release
gh repo clone org/repo      # Clone a repository

VS Code Extensions

Extension Purpose
github.copilot AI code completions
github.copilot-chat AI chat assistant
github.vscode-pull-request-github PR and issue management inside VS Code
github.vscode-github-actions GitHub Actions workflow editor with validation
github.remotehub Browse remote GitHub repositories without cloning

Authentication

Auto-auth via token (recommended)

Set GH_TOKEN (or GITHUB_TOKEN) in your environment and gh will authenticate automatically on shell startup — no manual gh auth login needed.

Local / DevPod: add to your devcontainer.json:

{
    "remoteEnv": {
        "GH_TOKEN": "${localEnv:GH_TOKEN}"
    }
}

Then set GH_TOKEN on your host machine (export GH_TOKEN=ghp_... in your shell profile).

GitHub Codespaces: GITHUB_TOKEN is injected automatically — gh is authenticated with no extra configuration.

CI/CD: set GH_TOKEN as a repository or organization secret.

SSH

Use dotfiles-sync to bring your SSH keys into the container.

Manual

gh auth login

Version History

  • v1.0.0: Initial release. gh CLI, Copilot, Copilot Chat, Pull Requests & Issues, GitHub Actions, RemoteHub extensions. Auto-auth via GH_TOKEN/GITHUB_TOKEN. Extracted from essential-dev.