第2章利用手順

本章では、本サービスを利用する手順について説明します。

セルフホストランナー上でGitHub Actionsのワークフロー処理を実行する手順を以下に示します。

Runner追加
ワークフロー作成
ワークフロー実行
ワークフロー実行結果の確認
Runner削除

Runner追加

GitHub Enterpriseのリポジトリ、Organization、あるいはEnterpriseで利用するRunnerをセルフホストランナーに追加するにはヘルプデスクまでお問い合わせください。設定内容を記入する設定シートをヘルプデスクから送付いたします。ワークフローを実行するには1つ以上のRunnerをセルフホストランナーに追加する必要があります。追加したRunnerにカスタムラベルを割り当てることで、特定のRunnerで実行されるワークフローを作成することもできます。

セルフホストランナーのラベルの利用

ワークフロー作成

ワークフローはセルフホストランナー上にセットアップされているコンテナ内で実行します。このため、ワークフローの実行環境となるコンテナイメージを準備し、そのコンテナイメージを利用してワークフローが実行されるようにワークフローを定義します。

ワークフロー実行環境となるコンテナイメージの準備

アプリケーションの開発言語に応じたコンパイラ・インタプリタ、テスト自動化ツール、デプロイ支援ツールなど、ワークフローの実行に必要なツールがセットアップされたコンテナイメージを準備します。コンテナイメージはDocker Hubなどで公開されているものをそのまま利用したり、公開されているコンテナイメージをベースにしてワークフローの実行に必要なツールを追加したイメージを作成することができます。

公開されているコンテナイメージをベースにしてワークフローの実行に必要なツールを追加したイメージを作成するにはワークフロー実行環境の作成例を参照してください。

ワークフロー定義

GitHub Actionsで実行するワークフローを作成します。ワークフローを作成する際にはワークフローの作成例を参照してください。

注意事項

セルフホストランナーでワークフローを実行する場合は、ワークフロー定義内で必ず jobs..container 構文を使用して、ワークフロー実行環境となるコンテナイメージの準備で準備したコンテナイメージを利用してワークフロー処理が実行されるように定義してください。構文の詳細はRunning jobs in a containerをご参照ください。
セルフホストランナー内にキャッシュされているコンテナイメージは定期的にクリアされます。
セルフホストランナーからインターネットへの通信はHTTPS通信およびHTTP通信のみが利用可能です。

ワークフロー実行

ワークフロー定義で指定したトリガーを発生させることでワークフローが実行されます。ワークフローを手動で実行することもできます。

ワークフロー実行結果の確認

ワークフローが正しく実行されたかを必ず確認します。

ワークフロー実行の履歴を表示する

Runner削除

不要になったRunnerをセルフホストランナーから削除するには、ヘルプデスクまでお問い合わせください。設定内容を記入する設定シートをヘルプデスクから送付いたします。