自动执行代码扫描预检查等工作

前言

一个项目，在推出去作为开源项目之后，自然而然就会吸引其他开发者来进行协同，当协同越来越多的时候，有一个能自动检测代码基本语法问题的预检，就非常重要。

本文就来讲一下，如何借助 Github Actions 自动执行各语言相关的代码检测扫描。

Go语言

所用 Actions。

使用配置其实非常简单，基本上阅读完官方介绍文档就可以上手使用了，这里说一两个需要注意的地方。

首先添加 Actions 配置文件，e.g. .github/workflows/go-ci.yml：

  1. name: golangci-lint
  3. on: [push, pull_request]
  5. jobs:
  6.   golangci:
  7.     name: golang-lint
  8.     runs-on: ubuntu-latest
  9.     steps:
  10.       - uses: actions/setup-go@v3
  11.         with:
  12.           go-version: 1.17
  13.       - uses: actions/checkout@v3
  14.       - name: golangci-lint
  15.         uses: golangci/golangci-lint-action@v3
  16.         with:
  17.           version: v1.46.2
  18.   build:
  19.     name: go-build
  20.     runs-on: ubuntu-latest
  21.     steps:
  22.     - uses: actions/checkout@v3
  23.     - name: Set up Go
  24.       uses: actions/setup-go@v3
  25.       with:
  26.         go-version: 1.17
  27.     - name: Build
  28.       run: go build -v ./...

配置项也都比较简单，不做过多赘述，根据自己的实际情况调整即可。

这个配置添加之后，每次有push的动作，或者PR的请求，都会自动运行该动作，示例如下：

image_20220724_084202

当这个步骤运行失败，则提交PR的人也会自行根据报错内容进行一些自检。

Node

使用的Actions。

  1. name: Test
  3.     on: [push, pull_request]
  5.     jobs:
  6.       lint:
  7.         runs-on: ubuntu-latest
  8.         steps:
  9.         - uses: actions/checkout@v2
  10.         - uses: actions/setup-node@v1
  11.           with:
  12.             node-version: '12.x'
  13.         - name: Install dependencies
  14.           uses: bahmutov/npm-install@v1
  15.         - name: Run linter
  16.           run: npm run lint
  18.       test:
  19.         runs-on: ubuntu-latest
  20.         steps:
  21.         - uses: actions/checkout@v2
  22.         - uses: actions/setup-node@v1
  23.           with:
  24.             node-version: '12.x'
  25.         - name: Install dependencies
  26.           uses: bahmutov/npm-install@v1
  27.         - name: Run test
  28.           run: npm test
  30.       build:
  31.         runs-on: ubuntu-latest
  32.         steps:
  33.         - uses: actions/checkout@v2
  34.         - uses: actions/setup-node@v1
  35.           with:
  36.             node-version: '12.x'
  37.         - name: Install dependencies
  38.           uses: bahmutov/npm-install@v1
  39.         - name: Build
  40.           run: npm run build

以上是拿两个语言作为例子，算是一个抛砖引玉，其他语言的检测，可参考官方文档：https://docs.github.com/cn/actions/automating-builds-and-tests/building-and-testing-go 进行配置。