GitHub初心者向け: GitHub Actionsの始め方

GitHub初心者向けシリーズ第3シーズンへようこそ！前回のエピソードでは、GitHub IssuesとProjectsの基本について説明しました。今回は、非常に人気の高い機能であるGitHub Actionsについて詳しく見ていきましょう。この記事を読み終える頃には、GitHub Actionsの使い方を理解し、最初の自動化ワークフローを作成できるようになります。 動画で視聴したい場合は、GitHub初心者向けシリーズの全エピソードをYouTubeでご覧いただけます（このチュートリアルの完全な動画は上記で視聴できます）。 **GitHub Actionsとは？** GitHub Actionsは、GitHubに組み込まれた継続的インテグレーション/継続的デリバリー（CI/CD）および自動化プラットフォームです。「アクションワークフロー」または単に「ワークフロー」と呼ばれることもあります。リポジトリに保存されたYAMLファイルを使用して、繰り返しのタスクやデプロイメントプロセスを自動化できます。脆弱性スキャンの実行、テスト、リリース作成、チームへの重要なお知らせなど、さまざまなタスクにGitHub Actionsを利用できます。 ワークフローは、プッシュ、プルリクエスト、スケジュールなどのGitHubイベントによってトリガーされ、仮想環境で実行されます。 **ワークフローの仕組み** ワークフローの詳細な仕組みに入る前に、いくつかの重要な用語を定義しておきましょう。 * **イベント**: ワークフローをトリガーする特定のアクティビティ（例：コードのプッシュ、プルリクエストの作成、Issueの作成など）。 * **ホステッドランナー**: ワークフロー内のジョブを実行する仮想マシン。GitHubが提供するホステッドランナーを使用するか、独自のセルフホステッドランナーを設定できます。 * **ジョブ**: 同じランナー内で実行される一連のステップ。各ステップは、シェルコマンドかGitHub Marketplaceの事前構築済みアクションのいずれかです。 ワークフローは、リポジトリ内で発生するイベント（プルリクエスト、ブランチのマージ、Issueの作成など）によってトリガーされます。ワークフローを作成する際に、どのイベントがトリガーとなるかを指定します。 イベントが発生してワークフローがトリガーされると、GitHubはランナー上で実行する1つ以上のジョブを起動します。その後、GitHubはワークフローに定義されたステップを最後まで自動的に実行します。これはすべて、ユーザーの操作を必要とせずに行われます。これがGitHub Actionsワークフローの基本的な仕組みです。 独自のワークフローを作成してGitHub Actionsにさらに慣れたい方は、スキルリポジトリにある「Hello GitHub Actions」スキル演習を試してみてください。 **リポジトリのアクションを確認する** サンプルリポジトリに移動し、フォークした後、上部の「Actions」タブを選択してください。このページには、リポジトリのすべてのワークフローが表示されます。左側の列にある緑色の「New workflow」ボタンを選択します。すると、このリポジトリに対して推奨されるいくつかのワークフローが表示された新しいページに移動します。 推奨されるアクションのいずれかの「Configure」ボタンを選択してください（現時点ではどれを選んでも構いません）。これにより、YAMLで記述されたテンプレートが表示されたエディターが開きます。ワークフローを構築する際に理解しておく必要がある主なセクションは3つです： * **name**: ワークフローの内容を説明します。 * **on**: ワークフローをトリガーする条件を定義します。 * **jobs**: このワークフローに関連する実際の作業が行われる場所です。 **ワークフローを構築する** 学ぶ最良の方法は実践することです。それでは、リポジトリに作成された新しいIssueに自動的にラベルを付ける簡単なワークフローを作成してみましょう。まず、サンプルリポジトリのメインページに戻り、お使いのマシンにクローンします。次に、`action-start`ブランチに移動します。 GitHub ActionsはYAML構文を使用してワークフローを定義します。各ワークフローは、リポジトリ内の特別な`.github/workflows`ディレクトリにある`.yml`ファイルに保存されます。そのディレクトリに移動してください。 ワークフローファイルを作成する際は、内容が一目でわかる説明的な名前（例：`build-and-test.yml`、`security-scanner.yml`）を使用することをお勧めします。今回は新しいIssueにラベルを付けるワークフローを作成したいので、このディレクトリに`label-new-issue.yml`という名前の新しいファイルを作成します。ファイルの先頭に以下を追加します： ```yaml name: Label New Issues ``` 次に、このワークフローをトリガーする条件を決定します。GitHubには多くのトリガーオプションがあり、すべてトリガーワークフローのリファレンスドキュメントに記載されています。今回は、誰かがIssueを開いたときにこのワークフローをトリガーしたいと思います。YAMLファイルに以下のコードを追加します。 ```yaml on: issues: types: [opened] ``` さて、いよいよ実際の作業が行われるジョブセクションです。まず、ジョブに名前を付け、実行するマシンの種類を選択します。GitHubは、Ubuntu、Windows、macOSのさまざまなバージョンがインストールされたホステッドランナーを提供しています。 このジョブを`label-issues`と名付け、`ubuntu-latest`で実行しましょう。これにより、GitHubは利用可能な最新バージョンのUbuntuランナーをプールから取得します。 また、アクションがリポジトリの内容を読み取り、ラベルを追加できるようにするための権限を設定する必要があります。ジョブ内で`permissions`キーワードを使用すると、そのジョブ内のすべてのアクションと実行コマンドに指定されたアクセス権が付与されます。 ```yaml jobs: label-issues: runs-on: ubuntu-latest permissions: issues: write contents: read ``` 次に、実際のステップを追加します。ここで、ジョブ内で何が行われるかを定義します。 ```yaml steps: - name: Checkout repository uses: actions/checkout@v6 - name: Add triage label env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} ISSUE_NUMBER: ${{ github.event.issue.number }} LABEL: "triage" run: gh issue edit "$ISSUE_NUMBER" --add-label "$LABEL" ``` ここでは2つの主要なキーワード、`uses`と`run`が使われています。 * `uses`は、GitHub Marketplaceから事前構築済みアクションを呼び出します。これらはオープンソースの再利用可能なアクションで、一般的なタスクを処理するため、すべてを一から作成する必要がありません。例としては、コードのチェックアウトやNode.jsのセットアップなどがあります。 * `run`は、コマンドやスクリプトを実行します。このキーワードは、1行のコードでも複数行のスクリプトでも同じように使用されます。 `env`セクションは環境変数を定義する場所です。`run`セクションでGitHub CLIを使用しているため、アクションがリポジトリにアクセスできるようにアクセストークンを提供する必要があります。これは`GH_TOKEN`環境変数を設定することで行います。GitHubはジョブ作成時に自動的に一時的なアクセストークンを生成し、`GITHUB_TOKEN`変数として提供します。 また、更新したいIssueと追加したいラベルを示す変数も必要です。この機能を動作させるには、そのラベルがすでにリポジトリに存在している必要があります。 おめでとうございます！これで最初のワークフローが完成しました！ **ワークフローをテストする** ワークフローが完成したので、テストしてみましょう。まず、これらの変更をリポジトリにプッシュし、`main`ブランチにマージする必要があります。コードのプッシュ方法についてご不明な点があれば、リポジトリへのコード追加方法を説明した以前のGitHub初心者向けエピソードを参照してください。 ワークフローがアップロードされたら、動作を確認してみましょう。ブラウザでリポジトリに移動し、「Issues」タブを選択します。右上隅にある緑色の「New issue」ボタンを選択します。ワークフローのテストであることがわかるタイトルと説明を入力し、ウィンドウ下部の「Create」をクリックします。 GitHubがIssueを作成すると、Issueの履歴が表示されるページに自動的に移動します。すべて正常に動作していれば、Issue作成から数秒以内に「triage」ラベルが追加されているのが確認できるはずです。 これで、特定のトリガーに基づいてアクションが自動的にタスクを処理する便利さがお分かりいただけたでしょう。 **現在のワークフローを確認する** ウィンドウ上部の「Actions」タブを選択します。左側の列にすべてのアクションが表示されます。「Label New Issues」を選択して、このワークフローの実行履歴のみを表示するようにフィルタリングします。 先ほど作成したテストIssueに対応する一番上のワークフローを選択します。これにより、この特定のワークフローインスタンスに関する詳細情報が表示されるページに移動します。メインウィンドウで「label-issues」を選択します。 これで、ワークフローを完了するために実行されたすべてのステップを確認できます。これは、ワークフローが期待通りに動作しない場合のデバッグに非常に役立ちます。このワークフローを再実行したい場合は、右上の「Re-run all jobs」ボタンをクリックします。 ワークフローを一時停止する必要がある場合は、「Actions」タブから行えます。そのタブに戻り、左側の列で再度「Label New Issues」を選択します。検索ボックスの隣、右側のウィンドウにある3点リーダー（…）をクリックします。表示されるオプションの1つが「Disable workflow」です。これを選択すると、ワークフローの実行は停止しますが、リポジトリから削除されるわけではないため、後で再有効化できます。 「Actions」タブは、すべてのワークフローを表示および管理する場所です。このビューから、デプロイメント、ランナー、メトリクス、パフォーマンス、キャッシュを確認できます。また、このタブから直接ワークフローファイルを表示および編集することも可能です。 **次は何をしましょうか？** GitHub ActionsはIssueへのラベル付けだけではありません。パッケージの公開、新しいコントリビューターへの歓迎メッセージ送信、コードのビルドとテスト、セキュリティチェックの実行など、さまざまなアクションを作成できます。 GitHub Actionsのドキュメントを確認して学習を続け、独自のワークフローを作成して実験を始めましょう。 Happy coding! レベルアップする準備はできましたか？これらの実践的なGitHubスキル演習をチェックして、GitHub Actionsで迅速に自動化ワークフローを構築しましょう > 「GitHub初心者向け: GitHub Actionsを使い始める」は、The GitHub Blogで最初に公開されました。

GitHub初心者向け: GitHub Actionsの始め方

背景や根拠まで確認しますか？

関連記事

調べる

選ぶ

サイト