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結合，請參見上面的高級示例。