注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。
Example overview
この記事では、ワークフローの例を使って、GitHub Actions の主な CI 機能の一部を示します。 When this workflow is triggered, it automatically runs a script that checks whether the GitHub Docs site has any broken links. If any broken links are found, the workflow uses the GitHub CLI to create a GitHub issue with the details.
次の図は、ワークフローの手� �とジョブ内でそれを実行する方法の概要を示したものです。
Features used in this example
このワークフロー例は、GitHub Actions の次の機能を示しています。
Feature | Implementation |
---|---|
定期的にワークフローを実行する: | schedule |
トークンのアクセス許可の設定: | permissions |
特定の条件が満たされない限り、ジョブが実行されないようにする: | if |
ワークフロー内のシークレットの参照: | シークレット |
リポジトリをランナーにクローンする: | actions/checkout |
ランナーへの node のインストール: | actions/setup-node |
Using a third-party action: | peter-evans/create-issue-from-file |
Running shell commands on the runner: | run |
Running a script on the runner: | Using script/check-english-links.js |
Generating an output file: | Piping the output using the > operator |
Checking for existing issues using GitHub CLI: | gh issue list |
Commenting on an issue using GitHub CLI: | gh issue comment |
Example workflow
次のワークフローは、GitHub ドキュメント エンジニアリング チー� によって作成されました。 github/docs
リポジトリ内でこのファイルの最新バージョンを確認するには、次を参照してく� さい。 check-all-english-links.yml
.
注: このワークフローの各行については、次のセクションの「例の説明」に説明があります。
|
Understanding the example
次の表では、GitHub Actions ワークフローを作成するときにこれらの各機能がどのように使われるかを説明します。
Code | Explanation |
---|---|
|
GitHub リポジトリの [アクション] タブに表示されるワークフローの名前。 |
|
Defines the
|
|
Modifies the default permissions granted to |
|
Groups together all the jobs that run in the workflow file. |
|
Defines a job with the ID |
|
Only run the |
|
Configures the job to run on an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see "Workflow syntax for GitHub Actions." |
|
Creates custom environment variables, and redefines the built-in |
|
Groups together all the steps that will run as part of the |
|
The |
|
This step uses the |
|
The |
|
This |
|
If the |
|
Uses the |
|
Uses
|
|
If an issue from a previous run is open and assigned to someone, then use |
|
If an issue from a previous run is open and is not assigned to anyone, then:
|
Next steps
- GitHub Actions の概念については、「GitHub Actions について」を参照してく� さい。
- 基本的なワークフローを作成するための詳細な手� �については、「GitHub Actions のクイック スタート」を参照してく� さい。
- GitHub Actions の基本操作に慣れている� �合、ワークフローとその機能については「ワークフローについて」で学習できます。