GitHubでPull Requestがマージされたら、リリースノートを作成する

■概要

GitHubでの開発プロジェクトにおいて、プルリクエストがマージされるたびにリリースノートを手作業で作成していませんか？この作業は定期的でありながら更新内容の正確な反映が求められるため、手間がかかり転記ミスなども発生しやすい業務です。このワークフローを活用すれば、GitHubのプルリクエスト情報をもとにリリースノートを自動で作成し、開発チームへの共有まで一気通貫で行うことが可能です。

‍

■このテンプレートをおすすめする方

• GitHubでの開発プロセスにおいて、リリースノートの自動作成に関心のある開発者の方
• プルリクエストのマージからリリースノート作成までの手作業に、時間や手間を感じているプロジェクトマネージャーの方
• 開発チーム内の情報共有を効率化し、プロダクトの更新履歴を正確に管理したいと考えている方

‍

■このテンプレートを使うメリット

• GitHubでプルリクエストがマージされるとリリースノートが自動で作成・共有されるため、これまで手作業にかかっていた時間を削減できます
• マージされたプルリクエストの情報を基に作成するため、手動での転記による記載漏れや間違いといったヒューマンエラーを防ぐことができます

‍

■フローボットの流れ

1. はじめに、GitHubとDiscordをYoomと連携します
2. 次に、トリガーでGitHubを選択し、「Pull Requestがマージされたら」というアクションを設定します
3. 続いて、オペレーションでGitHubの「プルリクエストを取得」アクションを設定し、マージされたプルリクエストの情報を取得します
4. 次に、オペレーションでGoogleドキュメントの「書類を発行する」アクションを設定し、取得した情報をもとにリリースノートを作成します
5. 最後に、オペレーションでDiscordの「ファイルを送信」アクションを設定し、作成されたリリースノートを指定のチャンネルに送信します

※「トリガー」：フロー起動のきっかけとなるアクション、「オペレーション」：トリガー起動後、フロー内で処理を行うアクション

‍

■このワークフローのカスタムポイント

• GitHubのトリガーおよびオペレーションでは、対象としたいリポジトリのオーナー名やリポジトリ名を任意で設定してください
• Googleドキュメントでリリースノートを作成する際に、元となる雛形書類のファイルIDや、作成した書類を格納するGoogle DriveのフォルダIDを任意で設定できます
• Discordでファイルを送信するアクションでは、通知先となるチャンネルのIDを任意で設定することが可能です

‍

■注意事項

• GitHub、DiscordのそれぞれとYoomを連携してください。
• GitHubでWebhookを設定する方法は「GitHubでWebhookを設定する方法」をご参照ください。