codeocean/build-go-libgit2

CircleCI Go项目构建镜像（含libgit2）

镜像概述

该镜像为CircleCI环境定制，旨在为依赖libgit2库的Go项目提供标准化构建环境。通过预配置Go开发环境与libgit2依赖，解决跨环境构建不一致问题，简化CI/CD流程中的依赖管理，确保Go项目在CircleCI中高效、可靠地完成编译、测试与打包。

核心功能与特性

1. 预配置开发环境

• 内置指定版本的Go编译器（支持1.18+版本）及标准工具链（go mod、go test等）
• 预编译并安装libgit2库及其开发文件（含头文件与静态/动态链接库）
• 包含常用构建工具（make、gcc、git等），满足复杂项目构建需求

2. CircleCI环境优化

• 支持CircleCI缓存机制，可缓存Go模块依赖（$GOPATH/pkg/mod）和libgit2编译产物
• 兼容CircleCI工作流语法，可直接集成到.circleci/config.yml配置文件
• 内置日志优化，输出符合CircleCI规范的构建日志，便于问题排查

3. 版本可控与一致性

• 镜像版本与Go、libgit2版本绑定（如v1.21.0-libgit2-1.6.4），确保依赖版本固定
• 基于官方轻量级基础镜像（如alpine或debian-slim），减少镜像体积并降低安全风险
• 构建流程透明化，所有依赖安装步骤通过Dockerfile版本控制，支持审计与追溯

使用场景

1. 依赖libgit2的Go项目构建

适用于使用git2go等libgit2绑定库的Go应用，解决手动编译libgit2的复杂性

2. 团队协作与环境标准化

为团队提供统一的构建环境，避免"本地可运行，CI构建失败"的环境差异问题

3. 自动化CI/CD流程

集成到CircleCI流水线中，作为构建阶段的执行环境，支持测试、编译、打包全流程自动化

使用方法与配置说明

基本使用（CircleCI配置）

在.circleci/config.yml中指定镜像，示例如下：

yaml
version: 2.1

jobs:
  build-go-app:
    docker:
      - image: [镜像名称]:[版本标签]  # 例如：myorg/go-libgit2-builder:v1.21.0-libgit2-1.6.4
    steps:
      - checkout  # 拉取代码
      
      - restore_cache:  # 恢复缓存的Go依赖
          keys:
            - go-mod-v1-{{ checksum "go.sum" }}
      
      - run: go mod download  # 下载Go模块依赖
      
      - save_cache:  # 缓存Go依赖
          paths:
            - /go/pkg/mod
          key: go-mod-v1-{{ checksum "go.sum" }}
      
      - run: go build -o app  # 编译应用
      - run: go test -v ./...  # 运行单元测试
      - run: ./app --version  # 验证构建产物

workflows:
  build-and-test:
    jobs:
      - build-go-app

环境变量配置

可通过环境变量自定义构建行为，常用变量如下：

本地测试方法

如需本地验证镜像功能，可通过以下命令启动容器：

bash
# 交互式运行镜像
docker run -it --rm -v $(pwd):/app -w /app [镜像名称]:[版本标签] sh

# 在容器内执行构建命令
go mod download
go build -o app

配置示例：完整CircleCI工作流

以下是包含测试、构建、部署的完整.circleci/config.yml示例：

yaml
version: 2.1

jobs:
  test:
    docker:
      - image: myorg/go-libgit2-builder:v1.21.0-libgit2-1.6.4
    steps:
      - checkout
      - restore_cache:
          keys: [go-mod-v1-{{ checksum "go.sum" }}]
      - run: go mod download
      - run: go test -race -coverprofile=coverage.txt ./...
      - store_artifacts:
          path: coverage.txt

  build:
    docker:
      - image: myorg/go-libgit2-builder:v1.21.0-libgit2-1.6.4
    steps:
      - checkout
      - restore_cache:
          keys: [go-mod-v1-{{ checksum "go.sum" }}]
      - run: go mod download
      - run: CGO_ENABLED=1 go build -o app -ldflags "-X main.version=${CIRCLE_SHA1:0:8}"
      - save_cache:
          paths: [/go/pkg/mod]
          key: go-mod-v1-{{ checksum "go.sum" }}
      - persist_to_workspace:
          root: .
          paths: [app]

  deploy:
    machine: true
    steps:
      - attach_workspace: { at: . }
      - run: ./deploy.sh  # 部署脚本，根据实际需求调整

workflows:
  test-build-deploy:
    jobs:
      - test
      - build: { requires: [test] }
      - deploy: { requires: [build], filters: { branches: { only: main } } }