GitHub オーガニゼーションのリポジトリ作成を通知する GitHub Actions ワークフローを作る
Back to Top
はじめに
#豆蔵の GitHub オーガニゼーションもメンバーが増えて、多くのリポジトリを把握するのが困難になってきました。
新規のリポジトリ作成の内容をチェックすることも必要になってきました。機密性の高い情報を扱う場合もあるため、リポジトリの可視性が public になっていないかを確認することは重要です。
この記事では、オーガニゼーションのリポジトリ作成を通知する仕組みを構築しようと試行錯誤した内容をお届けします。
豆蔵では Team プランで契約していますが、Enterprise プランならメンバーのリポジトリの作成を制限し、オーガニゼーションの管理者が依頼ベースで作成する運用も可能です。
開発者の自発的活動を阻害してしまうことにも繋がるため、個人的にはあまりこのような制約はかけたくはありませんが。
GitHub のイベント通知を Slack の Incoming Webhook で受ける(ダメ)
#Slack には Incoming Webhook というアプリで Webhook 経由の通知を受け取る汎用的な仕組みがあります。
最初 GitHub から Incoming Webgook でイベント通知すればいいのでと考えました。そこで、通知したい Slack チャンネルに Incoming Webhook を導入。
GitHub の オーガニゼーションの Settings で Webhooks > Add webhook で設定します。
通知するイベントを選択するオプションを指定。
「Repositories」を指定すると、リポジトリの作成・アーカイブ・可視性変更といったイベントを通知できます。
Slack の Incoming Webhook の URL を指定して、設定を完了しました。
この設定をしてからしばらくして、同僚の人がリポジトリを作ったことを知りましたが、チャンネルには通知が来ていませんでした。
GitHub 側では、イベントを通知しようとしていましたが、失敗していました。ステータス400ということで、リクエストのデータが不正だったようです。
Response には missing_text_orfallback_or_attachments
というメッセージが格納されています。
リクエストを見ると確かに text などのフィールドはありません。Incoming Webhook 用のメッセージに変換する中継サービスがないとダメそうです。ということで、GitHub の通知と Slack の Incoming Webhook を直接繋ぐのは無理でした。
GitHub の Slack アプリはどうか(ダメ)
#Slack には GitHub 公式のアプリもあるので、これが使えないかと考えました。
GitHub アプリのリポジトリは以下です。
この README.md を読んだところ、リポジトリ単位ではなく、オーガニゼーション単位のサブスクライブも可能なようです。試しに、チャンネルから、オーガニゼーションにサブスクライブしてみました。
通知されるイベントはスクリーンショットで列挙されているものだけのようで、オーガニゼーション内のリポジトリの Issue や PR などに関するイベントしか通知されません。ということでこの方法も NG でした。
GitHub App を使ったリポジトリイベントの通知に関しては以下の記事で紹介しています。
GitHub Actions でリポジトリの作成日時から検出する
#最後の手段は、GitHub API と GitHub Actions ワークフローで定期的にチェックして Slack に通知を飛ばす方法です。リアルタイム性はないですが、1日1回程度通知されれば実用上は十分でしょう。
以前、オーガニゼーションのメンバーを把握するためのワークフローを設置したリポジトリに新たにワークフローを追加することにしました。
この記事の時と同様、ランタイムは Bun、スクリプトは TypeScript を採用します。
ワークフローを JST で0時に起動して、GitHub の GraphQL でリポジトリの名前・URL・作成日時・可視性を取得し、作成日時が前日になっているものでフィルターするのがよさそうです。
以下のようなワークフローファイルを用意しました。
name: Notify New Repos to Slack
on:
schedule:
- cron: '0 15 * * *' #1
workflow_dispatch:
jobs:
notify:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Bun
uses: oven-sh/setup-bun@v2 #2
- name: Install dependencies
run: bun install --no-save #3
- name: Notify new repos to Slack
env:
GH_PAT: ${{ secrets.ORG_REPO_PAT }}. #4
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} #5
GITHUB_ORG: ${{ vars.ORG_NAME }} #6
run: bun run src/notify-new-repos.ts #7
各ステップの処理は以下のようになっています。
- UTC の15時(JST の0時)に起動
- Bun 環境をセットアップ
- bun install で octokit/graphql をインストール
- オーガニゼーションの参照権限を付与した PAT をシークレットから設定
- Slack チャンネルの Incoming Webhook の URL をシークレットから設定
- オーガニゼーション名を設定
- Bun スクリプトを実行
実行される Bun スクリプトを抜粋します。
最初に環境変数を読み込んでおきます。
const org = process.env.GITHUB_ORG;
const token = process.env.GH_PAT;
const slackWebhook = process.env.SLACK_WEBHOOK_URL;
GraphQL 部分。リポジトリを50件、作成日時(CREATED_AT)の降順(DESC)で取得するクエリーです。フィールドとして、リポジトリ名、URL、作成日時、可視性を取得しています。
const query = `
query($org: String!) {
organization(login: $org) {
repositories(first: 50, orderBy: {field: CREATED_AT, direction: DESC}) {
nodes {
name
url
createdAt
visibility
}
}
}
}
`;
Octokit を使って GraphQL でリポジトリのリストを取得する処理です。
let repos: { name: string; url: string; createdAt: string; visibility: string }[] = [];
try {
const data = await graphql<{ organization: { repositories: { nodes: typeof repos } } }>(query, {
org,
headers: { authorization: `token ${token}` }
});
repos = data.organization.repositories.nodes;
} catch (err) {
console.error('GitHub GraphQL API error:', err);
process.exit(1);
}
1日前に作られたリポジトリを取得するため、JST の前日の日付を作成し、GraphQL で取得したリポジトリのリストの作成日時が前日になっているものを抽出します。
const now = new Date();
const JST_OFFSET = 9 * 60;
const jstNow = new Date(now.getTime() + (JST_OFFSET - now.getTimezoneOffset()) * 60000);
const yesterday = new Date(jstNow);
yesterday.setDate(jstNow.getDate() - 1);
const ymd = (d: Date) => d.toISOString().slice(0, 10);
const yesterdayJSTDate = ymd(yesterday);
const newRepos = repos.filter(r => {
const created = new Date(r.createdAt);
const jstCreated = new Date(created.getTime() + JST_OFFSET * 60000);
return ymd(jstCreated) === yesterdayJSTDate;
});
最後に Slack の Webhook URL 向けにメッセージを作成し、送信します。
リポジトリが作成された場合、Slack への投稿に気づけるように @here
メンションをつけています。これはメッセージに <!here>
を含めることで実現できます。
let message: string;
if (newRepos.length) {
message = "<!here>\nList of newly created repositories:\n" +
newRepos.map(r => `• <${r.url}|${r.name}> (created at ${r.createdAt.slice(0,10)} ${r.visibility})`).join('\n');
} else {
message = "No new repositories were created yesterday.";
}
try {
const resp = await fetch(slackWebhook, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ text: message }),
});
if (!resp.ok) {
console.error('Slack notification failed:', await resp.text());
process.exit(1);
}
console.log('Slack notification succeeded:', message);
} catch (err) {
console.error('Slack notification failed:', err);
process.exit(1);
}
以下のような感じで、リポジトリ作成通知がチャンネルに届きます(手動実行したため、時刻は午前10時30分ごろになっています)。
さいごに
#以上、オーガニゼーション内のリポジトリ作成を検知するために実施した方法の紹介でした。
やはり、Slack の GitHub アプリでリポジトリのライフサイクルイベントを通知してほしいところですね。