gitlab+reviewdog+golangci-lint实现提交MR时进行代码检测

ivansli2022-06-222024-07-08

本文使用 shell 作为 gitlab-runner 执行器 (executor) 演示提交 MR 时执行代码检查。

gitlab搭建参考文章：<基于docker搭建的gitlab实现CI/CD>，本文只是把文章中 runner 执行器由 docker 变成了 shell。

1.准备工作

安装gitlab-runner、reviewdog、golangci-lint

#安装 gitlab-runner
curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.rpm.sh | sudo bash
#安装 reviewdog
curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s
#安装 golangci-lint
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.46.2

gitlab-runner 注册到 gitlab

sudo gitlab-runner register \
  --non-interactive \
  --executor "shell" \
  --docker-image alpine:latest \
  --url "http://101.132.194.252/" \
  --registration-token "GR1348941ZCPzw2JGx4ubLcwn25dy" \
  --description "register-runner" \
  --tag-list "shell-runner" \
  --run-untagged="true" \
  --locked="false" \
  --access-level="not_protected"

参数说明：

–executor runner执行器类型为shell
–url gitlab地址
–registration-token register需要的token(由gitlab提供)
–tag-list 当前 runner 的tag列表，job 通过 tags 来指定执行的runner

2.gitlab 代码仓库

.
├── .gitlab-ci.yml
├── .reviewdog.yml
├── go.mod
└── main.go

文件说明：

.gitlab-ci.yml gitlab执行CI/CD时需要的配置文件
.reviewdog.yml reviewdog需要的配置文件

.gitlab-ci.yml

stages:
  - test
  - golint
  - deploy

# job
build:
  # 执行阶段
  stage: golint
  tags:
    # 使用执行器的tag
    - shell-runner
  script:
    # 执行脚本
    # reviewdog 实现自动 comment 所需要的 token
    # 在 gitlab（ Setting -> Access Tokens ）中创建
    - export REVIEWDOG_GITLAB_API_TOKEN=bs8Wu4_FRWm4QZi4G5h2
    # 仓库所有者
    - export CI_REPO_OWNER=gitlab-instance-48689f56
    # 仓库名称
    - export CI_REPO_NAME=cicd-test
    # gitlab仓库 API 接口名
    - export GITLAB_API="http://101.132.194.252/api/v4"
    - export REVIEWDOG_INSECURE_SKIP_VERIFY=true
    - export CI_COMMIT=$(git rev-parse HEAD)
    - reviewdog -reporter=gitlab-mr-discussion
  only:
    # 当前 job 只在执行 MR 时才执行
    - merge_requests

.reviewdog.yml

runner:
  golint:
    # 执行 go lint
    cmd: golangci-lint run
    errorformat:
      - "%f:%l:%c: %m"
    level: warning

main.go

package main

import (
	"log"
	"net/http"

  // fmt 包未使用
	"fmt"
)

func main() {
  // num 变量未使用
	var num int
	
	s := http.NewServeMux()
	s.HandleFunc("/hello", func(writer http.ResponseWriter, request *http.Request) {
		writer.Write([]byte("hello world 7"))
	})

	if err := http.ListenAndServe(":8080", s); err != nil {
		log.Fatalln(err)
	}
}