在CircleCI上设置Golang项目的持续集成

60次阅读

问题描述

想要为他的Golang模块设置持续集成（Continuous Integration, CI），并希望进行测试、构建，并存储构建产物以供下载。此外，他还希望能够缓存依赖以供下一次构建使用。他的代码库结构如下所示：

+ repository_root/
  + go/
    - go.mod
    - go.sum
    + hello/
      - main.go
  + cpp/
  + python/
  + .circleci/

他在go.mod文件中定义了模块名为github.com/{USER}/{REPOSITORY_ROOT}/gogo。

他尝试在CircleCI上使用一个配置文件来进行构建，但是在构建过程中遇到了问题。

解决方案

请注意以下操作可能因版本差异而有所不同。

配置Dockerfile

为了能够在CircleCI上成功构建和测试Golang项目，我们可以将构建过程封装在Docker容器中。这样做的好处是，我们可以保证构建环境的一致性，而不受本地环境的影响。以下是一个示例的Dockerfile，你可以根据自己的项目需要进行调整。

# 使用Go的官方镜像作为基础镜像
FROM golang:1.16 AS build

# 设置工作目录
WORKDIR /app

# 复制项目文件到容器中
COPY go/go.mod go/go.sum ./
RUN go mod download

# 复制整个项目到容器中
COPY go/ ./

# 构建项目
RUN CGO_ENABLED=0 GOOS=linux go build -o bin/hello.exe github.com/{USER}/{REPOSITORY_ROOT}/go/hello

# 构建最终的镜像
FROM alpine:3.14
COPY --from=build /app/bin/hello.exe /app/
CMD ["/app/hello.exe"]

在上面的Dockerfile中，我们首先使用golang:1.16作为构建阶段的基础镜像。然后，我们设置工作目录，复制go.mod和go.sum文件，并运行go mod download来下载依赖。接下来，我们复制整个项目文件夹，并使用go build命令来构建项目。最后，我们切换到alpine:3.14镜像，将构建好的可执行文件复制到镜像中，并设置启动命令。

配置CircleCI

在CircleCI配置文件中，我们可以使用上述的Dockerfile来构建和测试Golang项目。以下是一个示例的.circleci/config.yml文件：

version: 2
jobs:
  build:
    docker:
      - image: docker:20.10.8
    steps:
      - checkout
      - setup_remote_docker:
          version: 20.10.8
      - run:
          name: Build and Test Golang Project
          command: |
            docker build -t my-golang-project .
            docker run --rm my-golang-project go test ./...
      - save_cache:
          paths:
            - /go/pkg/mod
          key: v1-deps-{{ .Branch }}-{{ checksum "go.mod" }}

在上面的配置中，我们使用了Docker 20.10.8版本的镜像来进行构建。首先，我们使用checkout步骤来获取代码。然后，我们使用setup_remote_docker步骤来设置远程Docker环境，以便我们能够在CircleCI内构建Docker镜像。接下来，我们使用docker build命令来构建Golang项目，并使用docker run命令来运行测试。最后，我们使用save_cache步骤来缓存依赖，以加快下一次构建的速度。