Understanding GitHub Actions

概要

GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline. You can create workflows that build and test every pull request to your repository, or deploy merged pull requests to production.

GitHub Actions goes beyond just DevOps and lets you run workflows when other events happen in your repository. For example, you can run a workflow to automatically add the appropriate labels whenever someone creates a new issue in your repository.

You must host your own Linux, Windows, or macOS virtual machines to run workflows for GitHub Enterprise Serverインスタンス. Self-hosted runners can be physical, virtual, in a container, on-premises, or in a cloud.

For more information about introducing GitHub Actions to your enterprise, see "Introducing GitHub Actions to your enterprise."

GitHub Actions のコンポーネント

You can configure a GitHub Actions workflow to be triggered when an event occurs in your repository, such as a pull request being opened or an issue being created. Your workflow contains one or more jobs which can run in sequential order or in parallel. Each job will run inside its own virtual machine runner, or inside a container, and has one or more steps that either run a script that you define or run an action, which is a reusable extension that can simplify your workflow.

ワークフロー

A workflow is a configurable automated process that will run one or more jobs. Workflows are defined by a YAML file checked in to your repository and will run when triggered by an event in your repository, or they can be triggered manually, or at a defined schedule.

Workflows are defined in the .github/workflows directory in a repository, and a repository can have multiple workflows, each of which can perform a different set of tasks. For example, you can have one workflow to build and test pull requests, another workflow to deploy your application every time a release is created, and still another workflow that adds a label every time someone opens a new issue.

For more information about workflows, see "Using workflows."

イベント

An event is a specific activity in a repository that triggers a workflow run. For example, activity can originate from GitHub when someone creates a pull request, opens an issue, or pushes a commit to a repository. You can also trigger a workflow run on a schedule, by posting to a REST API, or manually.

ワークフローのトリガーに使用できるイベントの完全なリストについては、ワークフローをトリガーするイベントを参照してく� さい。

ジョブ

A job is a set of steps in a workflow that execute on the same runner. Each step is either a shell script that will be executed, or an action that will be run. Steps are executed in order and are dependent on each other. Since each step is executed on the same runner, you can share data from one step to another. For example, you can have a step that builds your application followed by a step that tests the application that was built.

You can configure a job's dependencies with other jobs; by default, jobs have no dependencies and run in parallel with each other. When a job takes a dependency on another job, it will wait for the dependent job to complete before it can run. For example, you may have multiple build jobs for different architectures that have no dependencies, and a packaging job that is dependent on those jobs. The build jobs will run in parallel, and when they have all completed successfully, the packaging job will run.

For more information about jobs, see "Using jobs."

Actions

An action is a custom application for the GitHub Actions platform that performs a complex but frequently repeated task. Use an action to help reduce the amount of repetitive code that you write in your workflow files. An action can pull your git repository from GitHub, set up the correct toolchain for your build environment, or set up the authentication to your cloud provider.

You can write your own actions, or you can find actions to use in your workflows in the GitHub Marketplace.

詳細については、「アクションを作成する」を参照してく� さい。

ランナー

A runner is a server that runs your workflows when they're triggered. Each runner can run a single job at a time. You must host your own runners for GitHub Enterprise Server. For more information, see "Hosting your own runners."

サンプルワークフローを作成する

GitHub Actions uses YAML syntax to define the workflow. Each workflow is stored as a separate YAML file in your code repository, in a directory named .github/workflows.

コードがプッシュされるたびに一連のコマンドを自動的にトリガーするサンプルワークフローをリポジトリに作成できます。 In this workflow, GitHub Actions checks out the pushed code, installs the bats testing framework, and runs a basic command to output the bats version: bats -v.

1. リポジトリに、ワークフローファイルを保存するための .github/workflows/ ディレクトリを作成します。

2. .github/workflows/ ディレクトリに、learn-github-actions.yml という名前の新しいファイルを作成し、次のコードを追� します。

   name: learn-github-actions
   on: [push]
   jobs:
     check-bats-version:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v2
         - uses: actions/setup-node@v2
           with:
             node-version: '14'
         - run: npm install -g bats
         - run: bats -v
   

3. これらの変更をコミットして、GitHub リポジトリにプッシュします。

これで、新しい GitHub Actions ワークフローファイルがリポジトリにインストールされ、別のユーザがリポジトリに変更をプッシュするたびに自動的に実行されます。 To see the details about a workflow's execution history, see "Viewing the activity for a workflow run."

ワークフローファイルを理解する

YAML 構文を使用してワークフローファイルを作成する方法を理解しやすくするために、このセクションでは、導入例の各行について説明します。

name: learn-github-actions

on: [push]

jobs:

check-bats-version:

  runs-on: ubuntu-latest

  steps:

    - uses: actions/checkout@v2

    - uses: actions/setup-node@v2
      with:
        node-version: '14'

    - run: npm install -g bats

    - run: bats -v

ワークフローファイルの視覚化

この図では、作成したワークフローファイルと、GitHub Actions コンポーネントが階層にどのように整理されているかを確認できます。 Each step executes a single action or shell script. Steps 1 and 2 run actions, while steps 3 and 4 run shell scripts. ワークフローのビルド済みアクションの詳細については、「アクションの検索とカスタマイズ」を参照してく� さい。

Viewing the activity for a workflow run

When your workflow is triggered, a workflow run is created that executes the workflow. After a workflow run has started, you can see a visualization graph of the run's progress and view each step's activity on GitHub.

1. GitHub Enterprise Serverインスタンスで、リポジトリのメインページにアクセスしてく� さい。

2. リポジトリ名の下でActions（アクション）をクリックしてく� さい。

   

3. 左のサイドバーで、表示させたいワークフローをクリックしてく� さい。

   

4. "Workflow runs（ワークフローの実行）"の下で、表示させたい実行の名前をクリックしてく� さい。

   

5. [Jobs] または視覚化グラフで、表示するジョブをクリックします。

   

6. View the results of each step.

   

More complex examples

For examples that demonstrate more complex features of GitHub Actions, see "Examples." You can see detailed examples that explain how to test your code on a runner, access the GitHub CLI, and use advanced features such as concurrency and test matrices.

次のステップ

• GitHub Actions について詳しくは、「アクションの検索とカスタマイズ」を参照してく� さい。

• To understand how billing works for GitHub Actions, see "About billing for GitHub Actions".

サポートへの連絡

たとえば構文、GitHubホストランナー、アクションの構築など、ワークフローの設定に関して何か支援が必要な� �合は、GitHub Community SupportのGitHub Actionsカテゴリで既存のトピックを探してみるか、新しいトピックを開始してく� さい。

GitHub Actionsについてのフィードバックもしくは機能リクエストがあるなら、それらをFeedback discussion for GitHub Actionsで共有してく� さい。

あなたの利用方法、もしくは意図する利用方法が利用制限のカテゴリに当てはまるかどうかに関わらず、以下のいずれかの� �合はyour site administratorに連絡してく� さい。

• アカウントに間違った制約が課されていると思われる� �合
• たとえばユニークIDのような予想外のエラーに、アクションの実行時に遭遇した� �合
• 既存の動作が期待される、た� し必ずしもドキュメント化されてはいない動作と矛盾するような状況に遭遇した� �合

参考リンク

• "About GitHub Actions for enterprises"