GitHub Actions のクイックスタート

はじめに

GitHub Actions ワークフローを作成して実行するには、GitHub リポジトリのみが必要になります。このガイドでは、GitHub Actions の重要な機能のいくつかを示すワークフローを追加します。

次の例は、GitHub Actions ジョブを自動的にトリガーする方法、実行する場所、およびリポジトリ内のコードとやり取りする方法を示しています。

最初のワークフローを作成する

.github/workflows ディレクトリがまだ存在しない場合、リポジトリの GitHub でこのディレクトリを作成します。
.github/workflows ディレクトリに github-actions-demo.yml という名前のファイルを作成します。詳細については、「新しいファイルの作成」を参照してください。

次の YAML コンテンツを github-actions-demo.yml ファイルにコピーします。

YAML

name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
on: [push]
jobs:
  Explore-GitHub-Actions:
    runs-on: ubuntu-latest
    steps:
      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
      - name: Check out repository code
        uses: actions/checkout@v3
      - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
      - run: echo "🖥️ The workflow is now ready to test your code on the runner."
      - name: List files in the repository
        run: |
          ls ${{ github.workspace }}
      - run: echo "🍏 This job's status is ${{ job.status }}."

ページの下部までスクロールして、 [このコミットに新しいブランチを作成して pull request を開始] を選択してください。そして、pull request を作成するために [新しいファイルを提案] をクリックしてください。

リポジトリ内のワークフローファイルをブランチにコミットすると、push イベントがトリガーされ、ワークフローが実行されます。

ワークフローの結果を表示する

GitHub.com で、リポジトリのメインページへ移動します。 1. リポジトリ名の下の [Actions] (アクション) をクリックします。
左サイドバーで、表示するワークフローをクリックします。
ワークフローの実行リストから、表示させたい実行の名前をクリックしてください。
[ジョブ] で [Explore-GitHub-Actions] ジョブをクリックします。
ログには、各ステップの処理方法が表示されます。いずれかのステップを展開して、詳細を表示します。

たとえば、リポジトリ内のファイルのリストを確認できます。

追加したワークフロー例では、コードがブランチにプッシュされるたびにトリガーされ、GitHub Actions がリポジトリのコンテンツを処理できる方法が示されます。詳細なチュートリアルが必要な場合、「GitHub Actions を理解する」を参照してください。

その他のスターターワークフロー

GitHub には、独自の継続的インテグレーションワークフローを作成するためにカスタマイズできる事前構成済みのスターターワークフローが用意されています。 GitHub はコードを分析し、自分のリポジトリに役立つ可能性のある CI スターターワークフローを表示します。たとえばリポジトリにNode.jsのコードが含まれているなら、Node.jsプロジェクトのためのサジェッションが提示されます。スターターワークフローは、カスタムワークフローの構築の出発点として利用することも、そのまま利用することもできます。

スターターワークフローの完全な一覧については、actions/starter-workflows リポジトリを参照してください。

次の手順

GitHub Actions は、アプリケーション開発プロセスのほぼすべての要素を自動化するのに役立ちます。使い始める準備はできていますか。 GitHub Actions で次のステップに進む際に役立つ、以下のようなリソースを参照してください。

コードをビルドし、テストするための継続的インテグレーション (CI) ワークフローについては、「ビルドとテストの自動化」を参照してください。
パッケージのビルドと発行については、「パッケージの発行」を参照してください。
プロジェクトの展開については、「展開」を参照してください。
GitHub でタスクとプロセスを自動化する方法については、「issue と pull request を管理する」を参照してください。
上記のたくさんのユースケースを含む、GitHub Actions のより複雑な機能を示す例については、「例」を参照してください。ランナーでコードをテストする方法、GitHub CLI にアクセスする方法、コンカレンシーやテストマトリックスなどの高度な機能を使用する方法を説明する詳しい例を確認できます。