staticcheck action

StaticCheck-Action

Essa ação é executada no StaticCheck para encontrar bugs e outros problemas em seu código GO.

Uso

Na sua ação mais simples, basta adicionar dominikh/staticcheck-action como uma etapa no seu fluxo de trabalho existente. Um fluxo de trabalho mínimo pode ser assim:

 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 "

Um exemplo mais avançado que executa testes, vá veterinário e versões de static em várias versões OSS e Go se parecem:

 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 }}

Consulte a documentação do Github sobre ações para uma extensa documentação sobre como escrever e ajustar os fluxos de trabalho.

Opções

version

Qual versão do StaticCheck para usar. Como novas versões do StaticCheck introduzem novos cheques que podem quebrar sua compilação, é recomendável fixar em uma versão específica e atualizar o Staticheck conscientemente.

Isso padrão é latest , que instala a versão mais recente lançada do StaticCheck.

min-go-version

Versão mínima do Go que o StaticCheck relatará diagnósticos. Ou seja, alguns diagnósticos não se aplicam a versões mais antigas do GO.

Se não for definido, isso será padrão para a versão Go especificada no seu go.mod. O padrão é geralmente o que você deseja.

Consulte https://staticcheck.io/docs/running-staticcheck/cli/#go para obter mais informações.

build-tags

Vá construir tags que são passadas para o StaticCheck através do sinalizador -tags .

install-go

Se a ação deve instalar a versão mais recente do Go para instalar e executar o StaticCheck. Se o StaticCheck for a única ação em seu trabalho, essa opção geralmente poderá ser deixada em seu valor padrão do true . Se o seu trabalho já for instalado antes da execução do StaticCheck, por exemplo, para executar testes de unidade, é melhor definir esta opção como false .

O último lançamento do StaticCheck funciona com o último lançamento menor de Go na época.

cache-key

String a ser incluída na chave do cache, além do padrão, que é runner.os . Isso é útil ao usar várias versões GO.

working-directory

O caminho relativo para o diretório de trabalho StaticCheck deve ser executado. Isso é útil ao lidar com vários projetos em um repositório.

Pode ser facilmente combinado com uma matrix de diretório, consulte o exemplo avançado acima.