jheddings/gh

GitHub CLI Docker镜像

镜像概述和主要用途

一个基础Docker镜像，用于在CI环境中运行GitHub CLI（gh），提供便捷的GitHub命令行操作能力，支持集成到CI/CD流程中。

核心功能和特性

• 以gh命令为入口点，所有参数直接传递给gh执行
• 支持通过环境变量GITHUB_TOKEN配置认证令牌
• 声明/gh作为工作目录卷，便于数据持久化和目录挂载
• 兼容Docker和Kubernetes环境，适合作为CI/CD作业的初始化步骤

使用场景和适用范围

• CI/CD环境中执行GitHub操作（如克隆仓库、创建PR、管理issue等）
• 作为Kubernetes初始化容器，在主容器启动前完成GitHub相关准备工作
• 需要隔离gh运行环境的场景

使用方法和配置说明

基本使用

镜像使用gh作为入口点，参数直接传递给gh命令。例如，显示gh版本：

docker run jheddings/gh:latest --version

认证配置

gh CLI通过令牌进行访问，需设置环境变量GITHUB_TOKEN。测试令牌有效性：

docker run --env GITHUB_TOKEN=$MY_GH_TOKEN \
  jheddings/gh:latest auth status

说明：将$MY_GH_TOKEN替换为实际的GitHub开发者令牌（或使用环境变量引用）。

工作目录配置

镜像声明/gh为工作目录卷，可通过挂载卷实现本地目录映射。例如，克隆仓库到当前文件夹：

docker run --env GITHUB_TOKEN=$MY_GH_TOKEN --volume .:/gh \
  jheddings/gh:latest repo clone jheddings/notional

Kubernetes集成

常用作CI/CD作业的初始化容器，示例配置：

yaml
initContainers:
  - name: gh-clone
    image: jheddings/gh:latest
    env:
      - name: GITHUB_TOKEN
        valueFrom:
          secretKeyRef:
            name: github-token
            key: credential
    volumeMounts:
      - name: source-dir
        mountPath: /gh
    args: ["repo", "clone", "jheddings/notional"]
    imagePullPolicy: Always

containers:
  - volumeMounts:
      - name: source-dir
        mountPath: /var/lib/notional
    # 主容器配置...

volumes:
  - name: source-dir
    emptyDir: {}