github-script
Best practices for writing JavaScript code for GitHub Actions using github-script
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Best practices for writing JavaScript code for GitHub Actions using github-script
How to use
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.