Skip to main content

GitHub Actions のクイックスタート

GitHub Actions の機能を 5 分またはそれ以下で試すことができます。

はじめに

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

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

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

  1. .github/workflows ディレクトリがまだ存在しない場合、リポジトリの GitHub でこのディレクトリを作成します。 GitHub が含まれている GitHub Actions ワークフローを識別には、ディレクトリにこの正確な名前が必要です。

  2. .github/workflows ディレクトリで、.yml または .yaml 拡張子を持つファイルを作成します。 このチュートリアルでは、ファイルに github-actions-demo.yml という名前を使います。 詳しくは、「新しいファイルの作成」を参照してください。

  3. 次の 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@v4
          - 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 }}."
    
  4. ページの下部までスクロールして、 [このコミットに新しいブランチを作成して pull request を開始] を選択してください。 そして、pull request を作成するために [新しいファイルを提案] をクリックしてください。

    このページの [新しいファイルのコミット] 領域のスクリーンショット。

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

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

  1. GitHub.com で、リポジトリのメイン ページへ移動します。

  2. リポジトリ名の下にある [アクション] をクリックします。

    "github/docs" リポジトリのタブのスクリーンショット。 [アクション] タブがオレンジ色の枠線で強調表示されています。

  3. 左側のサイドバーで、表示するワークフローをクリックします。この例では、"GitHub Actions デモ" です。

    [アクション] ページのスクリーンショット。 サンプル ワークフローの名前 "GitHub Actions デモ" が、濃いオレンジ色の輪郭で強調表示されています。

  4. ワークフローの実行の一覧から、表示する実行の名前をクリックします。この例では、"USERNAME が GitHub Actions を試しています" です。

  5. ワークフローの実行ページの左側のサイドバーの [ジョブ] で、Explore-GitHub-Actions ジョブをクリックします。

    [ワークフローの実行] ページのスクリーンショット。 左側のサイドバーで、"Explore-GitHub-Actions" ジョブが濃いオレンジ色の輪郭で強調表示されています。

  6. ログには、各ステップの処理方法が表示されます。 いずれかのステップを展開して、詳細を表示します。

    ワークフローによって実行されるステップのスクリーンショット。

    たとえば、リポジトリ内のファイルの一覧を表示できます。

    ログ出力を表示するために展開された "リポジトリ内のファイルの一覧表示" ステップのスクリーンショット。 ステップの出力は、濃いオレンジ色で強調表示されています。

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

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

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

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

次の手順

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

  • GitHub Actions ワークフローを簡単に作成する方法については、「スターター ワークフローの使用」を参照してください。
  • コードをビルドし、テストするための継続的インテグレーション (CI) ワークフローについては、「ビルドとテストの自動化」を参照してください。
  • パッケージのビルドと発行については、「パッケージを公開する」を参照してください。
  • プロジェクトの配置については、「デプロイ」を参照してください。
  • GitHub でタスクとプロセスを自動化する方法については、「Issue と Pull Request の管理」を参照してください。
  • 上記のたくさんのユース ケースを含む、GitHub Actions のより複雑な機能を示す例については、「」を参照してください。 ランナーでコードをテストする方法、GitHub CLI にアクセスする方法、コンカレンシーやテスト マトリックスなどの高度な機能を使用する方法を説明する詳しい例を確認できます。
  • GitHub Certifications で GitHub Actions 認定を取得すると、GitHub Actions を使用してワークフローを自動化し、開発を加速する能力を証明できます。 詳しくは、「GitHub Certifications について」をご覧ください。