Gitlab CI/CD 实践六：统一管理 protocol buffer，API 大仓设计与实现

stages:
  - lint
  - generate

variables:
  BUF_CACHE_DIR: /cache/${CI_PROJECT_PATH}/buf-cache
before_script:
  - mkdir -p $BUF_CACHE_DIR

buf_lint:
  stage: lint
  image: 172.x.x.x/common/buf:1.6.0
  tags:
    - 172.x.x.x-runner
  interruptible: true
  script:
    - buf mod update
    - buf lint --error-format=json --timeout 5m

generate_go_file:
  stage: generate
  image: 172.x.x.x/common/buf:1.6.0
  tags:
    - 172.x.x.x-runner
  interruptible: true
  variables:
    TARGET_REPOSITORY_ADDR: git@xxx.com:xxxapis/xxx-api-go.git
    TARGET_REPOSITORY: xxx-api-go
  script:
    - chmod +x ./script/generate-go-file-to-xxx-api-go.sh
    - ./script/generate-go-file-to-xxx-api-go.sh

#!/bin/bash

echo "-------------------- 根据 proto 文件生成go代码 --------------------";
buf mod update;
buf generate --timeout 5m;

echo "-------------------- 同步 proto 文件生成的go代码到 ${TARGET_REPOSITORY} 仓库 --------------------";

echo "-------------------- 配置 git ssh，实现免密提交到 ${TARGET_REPOSITORY} 仓库 --------------------";
eval $(ssh-agent -s)
ssh-add <(echo "$CI_AUTO_SYNC_SSH_PRIVATE_KEY");
mkdir -p ~/.ssh;
touch ~/.ssh/config;
echo "StrictHostKeyChecking no" >> ~/.ssh/config;
echo "UserKnownHostsFile /dev/null" >> ~/.ssh/config;

echo "-------------------- 配置 git 用户信息为当前触发流水线的用户 --------------------";
git config --global user.email "$GITLAB_USER_EMAIL";
git config --global user.name "$GITLAB_USER_LOGIN";

echo "-------------------- git clone ${TARGET_REPOSITORY} 仓库，只拉取指定分支的最后一次 commit --------------------";
cd /tmp;
BRANCH=$CI_COMMIT_BRANCH;
if ! (git clone --depth 1 --branch $BRANCH $TARGET_REPOSITORY_ADDR); then
  echo "新建分支：$BRANCH"
  git clone --depth 1 --branch main $TARGET_REPOSITORY_ADDR;
  cd ${TARGET_REPOSITORY};
  git checkout -b $BRANCH;
fi

echo "-------------------- 拷贝go文件到 ${TARGET_REPOSITORY} 仓库 --------------------";
rm -rf /tmp/${TARGET_REPOSITORY}/xxx
mv $CI_PROJECT_DIR/apigen/xxx /tmp/${TARGET_REPOSITORY};
cd /tmp/${TARGET_REPOSITORY}
go mod tidy;

echo "-------------------- 提交到 ${TARGET_REPOSITORY} 仓库 --------------------";
cd /tmp/$TARGET_REPOSITORY;
git add .;
git commit -m "sync： 通过 ${CI_PROJECT_PATH} gitlab ci 同步 proto 文件生成的go代码" || true;
git push --set-upstream origin $BRANCH;
echo "-------------------- 同步成功 --------------------";

# 配置模块信息，包括依赖项
version: v1
deps:
  - buf.build/googleapis/googleapis
lint:
  use:
    - DEFAULT
  except:
    - FIELD_LOWER_SNAKE_CASE
    - RPC_REQUEST_STANDARD_NAME
    - RPC_RESPONSE_STANDARD_NAME
    - RPC_REQUEST_RESPONSE_UNIQUE
breaking:
  use:
    - FILE

# 配置protoc生成规则
version: v1
managed:
  enabled: true
  go_package_prefix:
    default: xxx.com/xxxapis/xxx-api-go
    except:
      - buf.build/googleapis/googleapis

plugins:
  - name: go
    out: apigen
    opt: paths=source_relative
  - name: go-grpc
    out: apigen
    opt:
      - paths=source_relative
      - require_unimplemented_servers=false
  - name: grpc-gateway
    out: apigen
    opt: paths=source_relative
  - name: openapiv2
    out: apigen
    opt:
      - allow_repeated_fields_in_body=true

module xxx.com/xxxapis/xxx-api-go

go 1.17

require (
   github.com/grpc-ecosystem/grpc-gateway/v2 v2.10.3
   google.golang.org/genproto v0.0.0-20220707150051-590a5ac7bee1
   google.golang.org/grpc v1.47.0
   google.golang.org/protobuf v1.28.0
)

require (
   github.com/golang/protobuf v1.5.2 // indirect
   golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd // indirect
   golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e // indirect
   golang.org/x/text v0.3.7 // indirect
)

git submodule add https://xxx.com/xxxapis/xxxapis.git

go get xxx.com/xxxapis/xxx-api-go@main