staticcheck action

静态检查

此操作运行静态检查，以查找GO代码中的错误和其他问题。

用法

最简单，只需将dominikh/staticcheck-action添加为您现有工作流程的步骤即可。最小的工作流程可能看起来像这样：

 name : " CI "
on : ["push", "pull_request"]

jobs :
  ci :
    name : " Run CI "
    runs-on : ubuntu-latest
    steps :
    - uses : actions/checkout@v2
      with :
        fetch-depth : 1
    - uses : dominikh/staticcheck-action@v1
      with :
        version : " latest "

一个更高级的示例，可以在多个OSS上运行测试，进行兽医和静态检查，并且GO版本看起来像这样：

 name : " CI "
on : ["push", "pull_request"]

jobs :
  ci :
    name : " Run CI "
    strategy :
      fail-fast : false
      matrix :
        os :  ["windows-latest", "ubuntu-latest", "macOS-latest"]
        go :  ["1.18.x", "1.19.x"]
        dir : ["server", "client"]
    runs-on : ${{ matrix.os }}
    steps :
    - uses : actions/checkout@v2
      with :
        fetch-depth : 1
    - uses : WillAbides/[email protected]
      with :
        go-version : ${{ matrix.go }}
    - run : " go test ./... "
    - run : " go vet ./... "
    - uses : dominikh/staticcheck-action@v1
      with :
        version : " latest "
        install-go : false
        cache-key : ${{ matrix.go }}
        working-directory : ${{ matrix.dir }}

请参阅GitHub的文档，以了解有关如何写入和调整工作流的大量文档。

选项

version

要使用哪个版本的静态检查。由于静态的新版本会引入可能破坏您的构建的新检查，因此建议您将特定版本固定并有意识地更新Staticheck。

它默认为latest ，它安装了最新发布的staticcheck版本。

min-go-version

staticCheck的最低版本将报告诊断。也就是说，有些诊断不适用于旧版本的GO。

如果未设置，则将默认为您的go.mod中指定的GO版本。默认值通常是您想要的。

有关更多信息，请参见https://staticcheck.io/docs/running-staticcheck/cli/#go。

build-tags

GO构建标签通过-tags标志传递到静态检查。

install-go

该操作是否应该安装最新版本以安装和运行静态检查。如果staticcheck是您工作中唯一的操作，则此选项通常可以留在其true的默认值上。如果您的作业已经安装在运行staticcheck之前，例如运行单元测试，则最好将此选项设置为false 。

最新版本的St奇克与当时的最后一个次要版本一起使用。

cache-key

除默认值之外， runner.os之外，还包括在缓存键中包含的字符串。使用多个GO版本时，这很有用。

working-directory

在处理一个存储库中的多个项目时，应执行与工作目录静态检查的相对路径。这很有用。

可以轻松地与目录matrix结合，请参见上面的高级示例。