staticcheck action

StaticCheck-action

Tindakan ini menjalankan StaticCheck untuk menemukan bug dan masalah lain dalam kode GO Anda.

Penggunaan

Secara sederhana, cukup tambahkan dominikh/staticcheck-action sebagai langkah dalam alur kerja Anda yang ada. Alur kerja minimal mungkin terlihat seperti ini:

 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 "

Contoh yang lebih canggih yang menjalankan tes, go vet dan staticCheck pada beberapa versi OS dan GO terlihat seperti ini:

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

Silakan lihat dokumentasi GitHub tentang tindakan untuk dokumentasi yang luas tentang cara menulis dan mengubah alur kerja.

Opsi

version

Versi StaticCheck mana yang akan digunakan. Karena versi baru StaticCheck memperkenalkan cek baru yang dapat merusak build Anda, disarankan untuk menyematkan versi tertentu dan memperbarui Staticheck secara sadar.

Default ke latest , yang menginstal versi terbaru StaticCheck.

min-go-version

Versi minimum Go That StaticCheck akan melaporkan diagnostik untuk. Artinya, beberapa diagnostik tidak berlaku untuk versi GO yang lebih lama.

Jika tidak ada, ini akan default ke versi GO yang ditentukan dalam go.mod Anda. Standarnya biasanya yang Anda inginkan.

Lihat https://staticcheck.io/docs/running-staticcheck/cli/#go untuk informasi lebih lanjut.

build-tags

Bangun tag yang diteruskan ke staticcheck melalui bendera -tags .

install-go

Apakah tindakan harus menginstal versi terbaru Go to Instal dan jalankan StaticCheck. Jika StaticCheck adalah satu -satunya tindakan dalam pekerjaan Anda, opsi ini biasanya dapat dibiarkan pada nilai default true . Jika pekerjaan Anda sudah menginstal sebelum menjalankan StaticCheck, misalnya untuk menjalankan tes unit, yang terbaik adalah mengatur opsi ini menjadi false .

Rilis terbaru StaticCheck Works dengan rilis minor terakhir dari Go at the Time.

cache-key

String untuk disertakan dalam tombol cache, selain default, yang merupakan runner.os . Ini berguna saat menggunakan beberapa versi GO.

working-directory

Jalur relatif ke direktori kerja StaticCheck harus dieksekusi. Ini berguna ketika berhadapan dengan banyak proyek dalam satu repositori.

Dapat dengan mudah dikombinasikan dengan matrix direktori, lihat contoh lanjutan di atas.