Toolverse
Wszystkie skille

github-script

autor: githubnext

Pisz JavaScript dla GitHub Actions zgodnie z najlepszymi praktykami

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
DevOps

O skillu

Skill zawiera wytyczne do pisania kodu JavaScript dla akcji GitHub Actions z użyciem github-script. Dowiesz się, jak prawidłowo logować komunikaty, ustawiać wyjścia akcji, zarządzać zmiennymi środowiskowymi i obsługiwać błędy. Poznasz też, jak generować podsumowania kroków w formacie Markdown oraz uniknąć typowych błędów w typowaniu i obsłudze wyjątków.

Jak używać

  1. Zapoznaj się z dostępnymi pakietami globalnymi: @actions/core i @actions/github są automatycznie dostępne w akcji actions/github-script@v8, nie musisz ich importować ani wymagać.

  2. Używaj funkcji logowania z pakietu @actions/core: zastosuj core.info(), core.warning() i core.error() zamiast console.log() czy console.error(). Jeśli chcesz oznaczyć akcję jako nieudaną, użyj core.setFailed() z komunikatem błędu.

  3. Zarządzaj wejściami i wyjściami akcji: pobieraj parametry wejściowe za pomocą core.getInput() (oznacz wymagane parametry atrybutem required: true), a wyniki ustawiaj funkcją core.setOutput(). Zmienne środowiskowe dla kolejnych kroków eksportuj przez core.exportVariable().

  4. Generuj podsumowanie kroku za pomocą core.summary.*: dodawaj zawartość Markdown funkcją core.summary.addRaw(), a na koniec wywołaj core.summary.write(), aby zapisać zmiany. Możesz łączyć wywołania w łańcuch.

  5. Unikaj typowych błędów: nie używaj typu any, zastąp go konkretnymi typami lub unknown. W bloku catch sprawdzaj, czy błąd jest instancją Error przed dostępem do właściwości message. Pamiętaj, że core.setFailed() automatycznie wywołuje core.error(), więc nie duplikuj tego wywołania.

  6. Sprawdź jakość kodu: uruchom make js do typowania TypeScript, make lint-cjs do lintowania i make fmt-cjs do formatowania pliku.

Podobne skille