github-script

GitHub Action スクリプトのベストプラクティス

actions/github-script@v8 で実行される JavaScript には、以下のガイドラインを使用してください。

重要な注意事項

• このアクションでは、@actions/core パッケージと @actions/github パッケージがグローバルに提供されます
• @actions/core の import または require を追加しないでください
• リファレンスドキュメント：
  • https://github.com/actions/toolkit/blob/main/packages/core/README.md
  • https://github.com/actions/toolkit/blob/main/packages/github/README.md

ベストプラクティス

• ログには console.log や console.error ではなく、core.info、core.warning、core.error を使用してください
• アクションの出力を設定するには core.setOutput を使用してください
• 後続のステップ用に環境変数を設定するには core.exportVariable を使用してください
• アクションの入力を取得するには core.getInput を使用し、必須の入力には required: true を指定してください
• エラーメッセージを付けてアクションを失敗としてマークするには core.setFailed を使用してください

ステップのサマリー

core.summary.* 関数を使用して、ステップのサマリーファイルに出力を書き込みます。

• 生の Markdown コンテンツ（GitHub Flavored Markdown に対応）を追加するには core.summary.addRaw() を使用してください
• 保留中の書き込みを反映するため、core.summary.write() を必ず呼び出してください
• サマリー関数の呼び出しは連結できます。例：core.summary.addRaw(...).addRaw(...).write()

よくあるエラー

• できる限り any 型は避け、代わりに具体的な型または unknown を使用してください
• Catch ハンドラーでは、message プロパティにアクセスする前に、エラーが Error のインスタンスかどうかを確認してください

catch (error) {
  core.setFailed(error instanceof Error ? error : String(error));
}

• core.setFailed は core.error も呼び出すため、両方を呼び出さないでください

型チェック

make js を実行して TypeScript コンパイラーを実行します。

make lint-cjs を実行してファイルを lint します。

編集後に make fmt-cjs を実行してファイルをフォーマットします。