はじめに
GitHub Actionsを利用する機会が多かったのですが、外部から実行する方法が分からなかった為わざわざリポジトリのページを開いて実行しており、だいぶ困っていました。
ある日、GitHub Actionsのドキュメントを見ていたところ、ワークフローを実行させるイベントの中にrepository_dispatchというものが存在することを知りました。
「これ使えば『リンク踏んだら実行』みたいなことできんじゃね？」と思ったので試してみました。
対象
- GitHub Actionsの基本は分かっている人
1.GitHub Personal Access Tokenの取得
外部からGitHub Actionsを実行するためには、GitHub Personal Access Tokenが必要です。取得方法は
次の記事様に詳しく書かれてあります。
こんな感じでチェックを付ければOKです。
2.GAS
2-1.GASへ移動
GoogleドライブからGoogle App Scriptを開いてください。
2-2.環境変数の設定
スクリプトにトークンをそのまま貼り付けるとセキュリティ的に非常にマズイので、先程取得したトークンを環境変数として設定します。
"プロジェクトの設定"→"スクリプトプロパティ"→"スクリプトプロパティを追加"を押します。
プロパティに「TOKEN」、値に先ほど取得したトークンを入力し終えたら"スクリプトプロパティを保存"を押してください。(画像の値はサンプルです)
2-3.スクリプトの作成
初期のコードを消してからコード.gsに以下のコードを貼り付けてください。
function doGet() {
const headers = {
'Authorization': 'token ' + PropertiesService.getScriptProperties().getProperty('TOKEN'),
'Accept' : 'application/vnd.github.everest-preview+json',
'Content-Type': 'application/x-www-form-urlencoded',
};
const data = {
'event_type': '<イベント名>'
};
const options = {
'method': 'post',
'payload': JSON.stringify(data),
'headers': headers
};
UrlFetchApp.fetch('https://api.github.com/repos/<ユーザー名>/<リポジトリ名>/dispatches', options);
}
<>がついている部分は自分の環境に合わせて置き換えてください。(置き換えたら<>は削除)
-
<イベント名>: 任意の名前(100文字以内) -
<ユーザー名>: GitHubのユーザー名 -
<リポジトリ名>: リポジトリ名
2-4.デプロイ
"デプロイ"→"新しいデプロイを作成"を押します。
デプロイタイプの選択を求められるので、設定マークを押して"ウェブアプリ"を選択してください。
新しい説明文はテキトーに入力し、"アクセスできるユーザー"を"全員"にしてデプロイを押します。
初回はデータへのアクセスを許可する必要があるので、"アクセスを承認"を押してください。
Googleアカウントにログイン後、以下のような画面が出てくるので"Advanced"→"Go to <プロジェクト名>(unsafe)"→"Allow"を押してください。
そしたらデプロイ完了です。URLはコピーしておいてください。
3.GitHub Actionsのymlファイルの設定
GitHub Actionsのymlファイルを以下のようにします。
name: <任意>
on:
repository_dispatch:
types: <イベント名>
jobs:
# 以下省略
typesの部分に先程の<イベント名>を入力します。(<>は削除)
これで準備は完了です。先程コピーしたURLを開くとGitHub Actionsが実行されます。
4.完了画面の追加(任意)
先程のコードの状態でURLを開き、実行に成功すると以下のような画面が表示されます。
このままだと寂しいので、最後の行に成功画面を表示するコードを追加します。「この画面のままでもいい」という方は飛ばして大丈夫です。
function doGet() {
/*省略*/
const options = {
'method': 'post',
'payload': JSON.stringify(data),
'headers': headers
};
UrlFetchApp.fetch('https://api.github.com/repos/<ユーザー名>/<リポジトリ名>/dispatches', options);
const html = '<p>実行完了</p>';
return HtmlService.createHtmlOutput(html);
}
htmlには、HTML文を文字列で構成して代入しています。
そしてHtmlOutputオブジェクトをリターンすることで、htmlの内容を反映したWebページを表示させることができます。
htmlの内容は自由に変更してください。
コードを追加し終えたら再度デプロイを行い、URLを開いてみてください。
すると...
...寂しさはあまり変わっていませんが、ちゃんと実行完了されたのが分かるようになったので多少マシにはなったかもしれません。