GitHub Actions中Go项目拉取私有依赖的GOROOT路径报错问题

之前遇到的两类报错，是三层配置错误叠加导致的，完全不需要硬改GOROOT就能解决：

• 手动篡改GOROOT环境变量。GOROOT是Go安装的根目录，由actions/setup-go自动配置到托管环境的缓存路径下，手动把它指向项目目录，会直接覆盖正确的原有值，导致Go找不到bufio这类自带的标准库。
• GOPATH和实际工作区路径错位。之前自定义的GOPATH路径没有和GitHub Actions的默认代码存放路径对齐，Go在GOPATH的src目录下找不到本地存的依赖，最终退回到GOROOT的src目录下查找，才会报“package dependency is not in GOROOT”的错误。
• Go模块路径映射缺失。Go 1.14默认开启GO111MODULE=on，如果不把本地克隆的私有依赖和go.mod里的导入路径做映射，模块系统根本识别不到本地的依赖代码。

整个方案完全遵循Go模块的官方查找逻辑，全程不碰GOROOT，也不需要把依赖强制塞到Go的系统目录下：

核心配置思路 #

• 完全依赖actions/setup-go自动配置的GOROOT，不手动做任何覆盖
• 把GOPATH设置为工作区下的可写路径，和代码存放路径对齐
• 通过go.mod的replace指令，把私有依赖的远程导入路径直接映射到本地克隆的代码路径
• 提前配置Git鉴权规则，避免拉取私有依赖时出现权限不足

完整Workflow示例 #

name: Build & Test

on:
  push:
    branches:
      - master

jobs:
  test:
    strategy:
      matrix:
        go-version: [1.14.x]
        platform: [ubuntu-latest]
    
    runs-on: ${{ matrix.platform }}
    
    steps:
    # 检出主仓库（原配置漏掉的关键前置步骤）
    - name: Check out main repo
      uses: actions/checkout@v2
      with:
        token: ${{ secrets.GIT_ACCESS_TOKEN }}

    # 安装Go环境，不手动覆盖GOROOT
    - name: Install Go
      uses: actions/setup-go@v2
      with:
        go-version: ${{ matrix.go-version }}
      env:
        GOPATH: ${{ github.workspace }}/go
        GO111MODULE: "on"
        # 配置私有仓库拉取规则，跳过公共代理、允许鉴权拉取
        GOPRIVATE: "github.com/你的用户名/*"
        GONOSUMDB: "github.com/你的用户名/*"

    # 配置Git私有仓库鉴权
    - name: Setup git auth
      run: |
        git config --global url."https://${{ secrets.GIT_ACCESS_TOKEN }}@github.com/".insteadOf "git@github.com:"
        git config --global url."https://${{ secrets.GIT_ACCESS_TOKEN }}@github.com/".insteadOf "https://github.com/"

    # 检出私有依赖仓库到项目内固定路径
    - name: Check out private dependency
      uses: actions/checkout@v2
      with:
        repository: 你的用户名/mydependency
        token: ${{ secrets.GIT_ACCESS_TOKEN }}
        path: ./local-deps/mydependency

    # 映射本地依赖到go.mod
    - name: Update go.mod replace config
      run: |
        go mod edit -replace github.com/你的用户名/mydependency=./local-deps/mydependency

    # 执行构建
    - name: Build
      run: go build ./...

    # 执行全量单元测试
    - name: Test
      run: go test ./...

• 别手动碰GOROOT环境变量，actions/setup-go装完Go之后，这个值已经配置成了正确的路径，手动改只会搞坏标准库的查找逻辑。
• 如果项目还在使用传统GOPATH模式而非Go modules，只需要把主仓库代码、私有依赖分别克隆到$GOPATH/src/对应导入路径下即可，同样不需要触碰GOROOT目录。
• 之前遇到的“依赖在GOROOT找不到”的报错，是Go遍历完所有可查找路径都没找到包后的兜底查找逻辑，不是必须要把依赖放到GOROOT目录下才能被识别。

内容的提问来源于stack exchange，提问作者mlang