staticcheck action

actions statiques

Cette action s'exécute StaticCheck pour trouver des bogues et d'autres problèmes dans votre code de rendez-vous.

Usage

À son plus simple, ajoutez simplement dominikh/staticcheck-action comme étape dans votre flux de travail existant. Un flux de travail minimal peut ressembler à ceci:

 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 exemple plus avancé qui exécute des tests, Go Vet et StaticCheck sur plusieurs versions OSS et GO ressemblent à ceci:

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

Veuillez consulter la documentation de GitHub sur les actions pour une documentation approfondie sur la façon d'écrire et de modifier les workflows.

Options

version

Quelle version de StaticCheck à utiliser. Étant donné que les nouvelles versions de StaticCheck introduisent de nouvelles vérifications susceptibles de briser votre version, il est recommandé d'épingler une version spécifique et de mettre à jour STAICHECK consciemment.

Il est par latest , qui installe la dernière version publiée de StaticCheck.

min-go-version

Version minimale de GO pour laquelle StaticCheck rapportera des diagnostics pour. Autrement dit, certains diagnostics ne s'appliquent pas aux anciennes versions de GO.

Si unset, cela sera par défaut la version Go spécifiée dans votre Go.mod. La valeur par défaut est généralement ce que vous voulez.

Voir https://staticcheck.io/docs/running-staticcheck/cli/#go pour plus d'informations.

build-tags

Allez construire des balises qui sont transmises à STATICCHECK via le drapeau -tags .

install-go

Si l'action doit installer la dernière version de GO To Installer et exécuter StaticCheck. Si StaticCheck est la seule action de votre travail, cette option peut généralement être laissée sur sa valeur par défaut de true . Si votre travail installe déjà avant d'exécuter StaticCheck, par exemple pour exécuter des tests unitaires, il est préférable de définir cette option sur false .

La dernière version de StaticCheck fonctionne avec la dernière sortie mineure de GO à l'époque.

cache-key

Chaîne à inclure dans la touche de cache, en plus de la valeur par défaut, qui est runner.os . Ceci est utile lors de l'utilisation de plusieurs versions GO.

working-directory

Le chemin relatif vers le répertoire de travail StaticCheck doit être exécuté.

Peut être facilement combiné avec une matrix de répertoire, voir l'exemple avancé ci-dessus.