デプロイ漏れを検知して通知するGitHub Actionを作った話

mofmofでは fourkeys を用いて開発生産性を計測しています。

あるプロジェクトチームが、複数のサービスを管理していました。コードレビュー、マージ、検証というフローを辿ってリリースされるのですが、検証完了後にリリース作業が漏れてしまうケースが有りました。

コミュニケーションやフローの改善での対応もしていますが、未リリースのものがあるかどうかの検知もしたい。

そこで、定期的にデプロイされていないものをチェックしてSlackへ通知するGitHub Actionsを作りました。

作ったGitHub Actions https://github.com/marketplace/actions/check-for-deployment-omissions

この記事ではこのアクションの使い方を紹介します。

1. Slackへ通知するためにアプリを作成する

以下のページへ行き、Slack Appを作成します https://api.slack.com/apps/

このとき、From an app manifest を選択して作成すると、yamlで設定を登録することになるので、以下のyamlを登録します。

display_information:
  name: Check for Deployment Omissions
settings:
  org_deploy_enabled: false
  socket_mode_enabled: false
  is_hosted: false
  token_rotation_enabled: false
features:
  bot_user:
    display_name: Check for Deployment Omissions
oauth_config:
  scopes:
    bot:
      - chat:write
      - chat:write.public

Appが作成されたら、Workspaceにインストールします。 Bot User OAuth Token が発行されるので、それをコピーしておきましょう。

2. デプロイ漏れを検知したいリポジトリにGitHub Actionsを設定する

以下のようなファイルを作成することで設定ができます。

.github/workflows/check-for-deployment-omissions.yml

name: 'check-for-deployment-omissions'
on:
  schedule:
    - cron: '0 0 * * 1'

jobs:
  check-for-deployment-omissions:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: mofmof/check-for-deployment-omissions@v0
        with:
          base_branch: 'main'
          deployment_environment_name: 'production'
          github_token: ${{ secrets.GITHUB_TOKEN }}
          slack_token: ${{ secrets.SLACK_TOKEN }}
          slack_channel: ${{ vars.SLACK_CHANNEL }}