staticcheck action

staticcheck-acción

Esta acción ejecuta StaticCheck para encontrar errores y otros problemas en su código GO.

Uso

En su forma más simple, simplemente agregue dominikh/staticcheck-action como un paso en su flujo de trabajo existente. Un flujo de trabajo mínimo puede verse así:

 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 "

Un ejemplo más avanzado que ejecuta las pruebas, Go Vet y StaticCheck en múltiples versiones OSS y GO se ve así:

 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 la documentación de GitHub sobre acciones para una extensa documentación sobre cómo escribir y ajustar los flujos de trabajo.

Opción

version

Qué versión de StaticCheck usar. Debido a que las nuevas versiones de StaticCheck introducen nuevas verificaciones que pueden romper su construcción, se recomienda fijar a una versión específica y actualizar STATICHECK conscientemente.

El valor predeterminado es latest , que instala la última versión lanzada de StaticCheck.

min-go-version

Versión mínima de GO que StaticCheck informará diagnósticos para. Es decir, algunos diagnósticos no se aplican a versiones anteriores de GO.

Si no log, esto se debe predeterminar a la versión GO especificada en su Go.mod. El valor predeterminado suele ser lo que desea.

Consulte https://staticcheck.io/docs/running-staticcheck/cli/#go para obtener más información.

build-tags

Vaya a construir etiquetas que pasen a StaticCheck a través de la bandera -tags .

install-go

Si la acción debe instalar la última versión de Go para instalar y ejecutar StaticCheck. Si StaticCheck es la única acción en su trabajo, esta opción generalmente se puede dejar en su valor predeterminado de true . Si su trabajo ya se instala antes de ejecutar StaticCheck, por ejemplo, para ejecutar pruebas unitarias, es mejor establecer esta opción en false .

El último lanzamiento de StaticCheck funciona con el último lanzamiento menor de Go en ese momento.

cache-key

Cadena para incluir en la tecla Cache, además del valor predeterminado, que es runner.os . Esto es útil cuando se usa múltiples versiones GO.

working-directory

La ruta relativa al directorio de trabajo StaticCheck debe ejecutarse. Esto es útil cuando se trata de múltiples proyectos dentro de un repositorio.

Se puede combinar fácilmente con una matrix de directorio, vea el ejemplo avanzado anterior.