github-script
Pisz JavaScript dla GitHub Actions zgodnie z najlepszymi praktykami
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
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ć
Zapoznaj się z dostępnymi pakietami globalnymi:
@actions/corei@actions/githubsą automatycznie dostępne w akcjiactions/github-script@v8, nie musisz ich importować ani wymagać.Używaj funkcji logowania z pakietu
@actions/core: zastosujcore.info(),core.warning()icore.error()zamiastconsole.log()czyconsole.error(). Jeśli chcesz oznaczyć akcję jako nieudaną, użyjcore.setFailed()z komunikatem błędu.Zarządzaj wejściami i wyjściami akcji: pobieraj parametry wejściowe za pomocą
core.getInput()(oznacz wymagane parametry atrybutemrequired: true), a wyniki ustawiaj funkcjącore.setOutput(). Zmienne środowiskowe dla kolejnych kroków eksportuj przezcore.exportVariable().Generuj podsumowanie kroku za pomocą
core.summary.*: dodawaj zawartość Markdown funkcjącore.summary.addRaw(), a na koniec wywołajcore.summary.write(), aby zapisać zmiany. Możesz łączyć wywołania w łańcuch.Unikaj typowych błędów: nie używaj typu
any, zastąp go konkretnymi typami lubunknown. W blokucatchsprawdzaj, czy błąd jest instancjąErrorprzed dostępem do właściwościmessage. Pamiętaj, żecore.setFailed()automatycznie wywołujecore.error(), więc nie duplikuj tego wywołania.Sprawdź jakość kodu: uruchom
make jsdo typowania TypeScript,make lint-cjsdo lintowania imake fmt-cjsdo formatowania pliku.