はじめに
GitHub Actions ワークフローを作成して実行するには、既存の GitHub リポジトリのみが必要です。 このガイドでは、GitHub Super-Linter アクションを使用して複数のコーディング言語の文法チェックを行うワークフローを追加します。 ワークフローは Super-Linter を使用して、新しいコミットがリポジトリにプッシュされるたびにソースコードを検証します。
最初のワークフローを作成する
-
GitHub のリポジトリから、
superlinter.ymlという名前の新しいファイルを.github/workflowsディレクトリに作成します。 詳細は「新しいファイルを作成する」を参照してください。 -
次の YAML コンテンツを
superlinter.ymlファイルにコピーします。 注釈: デフォルトブランチがmainでない場合は、リポジトリのデフォルトブランチ名と一致するようにDEFAULT_BRANCHの値を更新してください。YAML name: Super-Linter # 新しいコミットがリポジトリにプッシュされるたびにこのワークフローを実行する on: push jobs: # ジョブキーを設定する。 ジョブ名が指定されていない場合、 # キーはジョブ名として表示される super-lint: # ジョブ名を付ける name: Lint code base # 実行するマシンのタイプを設定する runs-on: ubuntu-latest steps: # ubuntu-latest マシンでリポジトリのコピーをチェックアウトする - name: Checkout code uses: actions/checkout@v2 # Super-Linter アクションを実行する - name: Run Super-Linter uses: github/super-linter@v3 env: DEFAULT_BRANCH: main GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} -
ワークフローを実行するには、ページの一番下までスクロールし、[Create a new branch for this commit and start a pull request] を選択します。 次に、[Propose new file] をクリックしてPull Requestを作成します。
リポジトリ内のワークフローファイルをコミットすると、push イベントがトリガーされ、ワークフローが実行されます。
ワークフローの結果を表示する
-
GitHubで、リポジトリのメインページにアクセスしてください。
-
リポジトリ名の下でActions（アクション）をクリックしてください。
-
左のサイドバーで、表示させたいワークフローをクリックしてください。
-
From the list of workflow runs, click the name of the run you want to see.
-
Jobs（ジョブ）の下、もしくは可視化グラフ内で、Lint code baseジョブをクリックしてください。
-
Any failed steps are automatically expanded to display the results.
さらなるワークフローテンプレート
GitHub provides preconfigured workflow templates that you can customize to create your own continuous integration workflow. GitHub analyzes your code and shows you CI templates that might be useful for your repository. たとえばリポジトリにNode.jsのコードが含まれているなら、Node.jsプロジェクトのためのサジェッションが提示されます。 ワークフローテンプレートは、カスタムワークフローの構築の出発点として利用することも、そのまま利用することもできます。
actions/starter-workflows リポジトリ。
次のステップ
追加した super-linter ワークフローは、コードがリポジトリにプッシュされるたびに実行され、コードのエラーや不整合を見つけます。 ただし、これは GitHub Actions でできることの一部にすぎません。 リポジトリには、さまざまなイベントに基づいてさまざまなジョブをトリガーする複数のワークフローを含めることができます。 GitHub Actions は、アプリケーション開発プロセスのほぼすべての要素を自動化するのに役立ちます。 開始する場合、 GitHub Actions で次のステップに進む際に役立つ、以下のようなリソースを参照してください。
- 詳細なチュートリアルは、「GitHub Actionsを学ぶ」
- 特定の使用例とサンプルについては、「ガイド」
- Super-Linter アクションの設定の詳細については、github/super-linter
はじめに
"Hello, World!"を出力するのは、基本的なセットアップと新しいプログラミング言語の構文を探るための素晴らしい方法です。 このガイドでは、GitHub Actionsを使ってGitHubリポジトリのワークフローログに"Hello, World!"と出力します。 始めるのに必要なものは、サンプルのGitHub Actionsワークフローを快適に作成して実行できそうなGitHubリポジトリだけです。 このクイックスタートのために新しいリポジトリを作成してもかまいません。それを使って、今回と将来のGitHub Actionsワークフローをテストできます。
最初のワークフローの作成
-
GitHubのリポジトリから、
.github/workflowsディレクトリ内にhello-world.ymlという名前で新しいファイルを作成してください。 詳しい情報については「新しいファイルの作成」を参照してください。 -
以下のYAMLの内容を
hello-world.ymlファイルにコピーしてください。YAML name: Say hello! # GitHub Actionsのワークフローは、GitHubのイベントで自動的にトリガーされます on: # このワークフローではworkflow_dispatchイベントを使います。これは、ユーザがGitHub ActionsのUIでRun workflowをクリックしたときにトリガーされます workflow_dispatch: # workflow_dispatchイベントはオプションの入力を受け付けるので、ワークフローの振る舞いをカスタマイズできます inputs: name: description: 'Person to greet' required: true default: 'World' # イベントがトリガーされると、GitHub Actionsは示されたジョブを実行します jobs: say_hello: # ubuntu-latesランナーを使ってリクエストされたステップを完了させます runs-on: ubuntu-latest steps: - run: | echo "Hello ${{ github.event.inputs.name }}!" -
ページの株間でスクロールして、Create a new branch for this commit and start a pull request（このコミットに新しいブランチを作成してPull Requestを開始）を選択してください。 そして、Pull Requestを作成するためにPropose new file（新しいファイルを提案）をクリックしてください。
-
Pull Requestがマージされたら、"Trigger your workflow（ワークフローをトリガー）"に移動する準備ができます。
ワークフローのトリガー
- GitHubで、リポジトリのメインページにアクセスしてください。
- リポジトリ名の下でActions（アクション）をクリックしてください。
- 左のサイドバーで、実行したいワークフローをクリックしてください。
- 右側でRun workflow（ワークフローを実行）ドロップダウンをクリックし、Run workflow（ワークフローを実行）をクリックしてください。 あるいは、ワークフローを実行する前にカスタムメッセージを"Person to greet"インプットに入力することもできます。
- ワークフローの実行は、"Say hello!"ワークフローの実行リストの先頭に表示されます。 ワークフローの実行結果を見るには、"Say hello!"をクリックしてください。
- 左のサイドバーで、"say_hello"ジョブをクリックしてください。
- ワークフローのログ中で、'Run echo "Hello World!"'セクションを展開してください。
さらなるワークフローのテンプレート
GitHub provides preconfigured workflow templates that you can customize to create your own continuous integration workflow. GitHub analyzes your code and shows you CI templates that might be useful for your repository. たとえばリポジトリにNode.jsのコードが含まれているなら、Node.jsプロジェクトのためのサジェッションが提示されます。 ワークフローテンプレートは、カスタムワークフローの構築の出発点として利用することも、そのまま利用することもできます。
actions/starter-workflows リポジトリ。
次のステップ
今追加したhello-worldワークフローは、手動でトリガーされるワークフローのシンプルな例です。 これは、GitHub Actionsでできることのほんの手始めに過ぎません。 リポジトリには、さまざまなイベントに基づいてさまざまなジョブをトリガーする複数のワークフローを含めることができます。 GitHub Actions は、アプリケーション開発プロセスのほぼすべての要素を自動化するのに役立ちます。 始める準備はできましたか？ 以下は、GitHub Actionsで次のステップへ進むのに役立つリソースです。
- 詳細なチュートリアルとして「GitHub Actionsを学ぶ」
- 特定のユースケースや例のための「Guides」