

・
「GitHubでプルリクエストが作成されるたびに、手動でレポート用のPDFを作成するのが面倒…」
「開発の進捗に合わせてドキュメントを更新する作業に時間がかかり、本来のコーディングに集中できない…」
このように、開発プロセスにおける手作業でのドキュメント作成に課題を感じていませんか?
もし、<span class="mark-yellow">GitHubでのプルリクエスト作成といった特定のアクションをきっかけに、必要な情報を盛り込んだPDFドキュメントを自動で生成し、関係者に共有できる仕組み</span>があれば、これらの煩わしい作業から解放されることも可能です。そのうえ、より重要な開発業務に集中できる貴重な時間を生み出すことができます!
今回ご紹介する自動化は、ノーコードで簡単に設定できて、手間や時間もかからないので、ぜひ自動化を導入して作業をもっと楽にしましょう!
Yoomには<span class="mark-yellow">GitHubの情報を基にPDFドキュメントを自動生成する業務フロー自動化のテンプレート</span>が用意されています。
「まずは試してみたい!」という方は、以下のバナーをクリックして、すぐに自動化を体験してみましょう!
それではここから代表的な例として、GitHubでプルリクエストが作成された際に、その情報を基にGoogleドキュメントでPDFを自動で作成し、送信するフローを解説していきます!
ここではYoomを使用してノーコードで設定をしていくので、もしまだYoomのアカウントをお持ちでない場合は、こちらの登録フォームからアカウントを発行しておきましょう。
※今回連携するアプリの公式サイト:GitHub/Googleドキュメント
[Yoomとは]
今回は大きく分けて以下のプロセスで作成します。
ここでは、Yoomとそれぞれのアプリを連携して、操作が行えるようにしていきます。
まずは基本的な設定方法を解説しているナビをご覧ください!
こちらのナビで紹介しているGoogle スプレッドシートを参考に、Googleドキュメントのマイアプリ連携をしてください。
GitHubをマイアプリ連携
以下の手順をご参照ください。
雛形書類の作成方法については以下のリンク先をご覧ください。
今回は以下のような雛形を作成しました。

以下のバナーにある試してみるボタンをクリックしてください。
テンプレートのコピーに成功すると、以下の画面が表示されますのでOKをクリックしましょう。
なお、コピーしたテンプレートはYoomのマイプロジェクトから確認できます。

プルリクエストが作成されたらをクリックします。

連携するアカウント情報にはステップ1で連携したアカウントか、連携時に使用していたYoomのアカウントが表示されます。
アカウントを確認して問題なければ次へをクリックしてください。

トリガーの起動間隔を設定します。

GitHubの画面に移動し、プルリクエストを作成しましょう。
今回ご紹介するテンプレートは、GitHubにプルリクエストが作成されたら起動します。
そのため、実際にテストを行うにはプルリクエストを作成する必要があるのです。
今回は以下のプルリクエストを作成しました。
プルリクエストが作成できたら、GitHubのプルリクエストが表示されている画面のURLをコピーしてください。

Yoomの画面に戻り、リポジトリの所有者とリポジトリ名を入力します。
注釈を確認し、先ほどコピーしたURLからそれぞれの箇所を抜き出して入力してください。
入力できたらテストをクリックしましょう。

テストに成功するとテスト成功画面が表示され、取得した値が表示されるはずです。
取得した値は実行した結果が設定される動的な値として利用できるため、このあとの設定でも使用します。
詳しく知りたい方は以下のリンク先をご覧ください。
確認できたら忘れずに完了をクリックしましょう。


書類を発行するをクリックします。

連携するアカウント情報にはステップ1で連携したアカウントか、連携時に使用していたYoomのアカウントが表示されます。
アカウントを確認して問題なければ次へ進みます。

ドキュメントのファイルIDを設定します。
入力欄をクリックし、事前準備で作成した雛形を選択してください。

格納先のGoogle DriveフォルダIDを設定します。
こちらも入力欄をクリックし、格納先を選択してください。

出力ファイル名を設定します。
デフォルトで設定されていますが、自由に変更可能です。
入力欄をクリックすることで取得した値を追加することもできます。
取得した値を活用することで、固定値ではなく、トリガーが実行されるたびに最新の情報が反映できます。
また、直接入力すると入力した値が固定値となり、このテンプレートを通して作成される全てのフィル名に反映されますのでご注意ください。
ここまで設定できたら次へをクリックしましょう。

置換対象の文字列と置換後の文字列の設定を行いましょう。
ここでは雛形に設定した置換対象の文字列に取得した値を設定します。
デフォルトで設定されていますが、置換対象の文字列に雛形で準備したものが表示されていない場合は、右上にある置換条件を再取得をクリックしてください。
※置換条件を再取得をクリックすると、現在表示されているものの下に新しく置換対象の文字列が表示されます。
それぞれ取得した値を設定してください。
また、使用しない置換対象の文字列はデフォルトのまま(取得した値が入っている状態)にしてください。
全て設定しているのを確認したらテストをクリックしましょう。
※テストをクリックすると実際に書類が作成されます。

テストに成功するとテスト成功画面と取得した値が表示されますのでご確認ください。
確認できたら完了をクリックしましょう。

先ほど指定した格納先にファイルが保存されていますので確認しておきましょう。

また、実際に書類内に取得した値が設定されているか確認してください。

メールを送るをクリックします。

Toを設定します。
任意のメールアドレスを設定してください。
※メールアドレスを直接入力すると、固定値となりこのテンプレートを通して作成される全てのメールの宛先として設定されます。

件名、本文を設定します。
それぞれデフォルトで設定されていますが、自由に変更可能です。
入力欄をクリックすることで取得した値を設定することも、直接入力することもできます。
続いて、添付ファイルを設定しましょう。
取得した値を使用、発行した書類となっていることを確認してください。
その他の項目について、今回は使用しないため設定しておりませんが、使用したい方は注釈を確認しご入力ください。
※このページ内で入力欄に直接記入すると入力した値が固定値となり、このテンプレートを通して作成される全てのメールに適用されますので注意しましょう。
ここまで設定できたら次へをクリック。

メールの送信内容を確認します。
問題なければテストをクリックしましょう。
※テストをクリックすると実際にメールが送信されます。

テストに成功するとテスト成功画面と取得した値が表示されますのでご確認ください。
確認できたら完了をクリックしましょう。

実際にメールが送信されていますので確認しておきましょう。

先ほどのYoomの画面で完了をクリックすると以下の画面が表示されます。
トリガーをONをクリックしてください。

お疲れ様でした!ここまでで設定は完了です!
以上がGitHubでプルリクエストが作成された際に、その情報を基にGoogleドキュメントでPDFを自動で作成し、送信するフローでした!
今回ご紹介した連携以外でも、GitHubのAPIを活用してさまざまな業務を自動化することが可能です。
例えば、GitHubにIssueが作成されるたびに、Google スプレッドシートやNotion、Trelloに自動で情報を追加することができます。
この自動化により、チーム内での進捗管理がスムーズに進み、手動での情報更新の手間を省くことが可能です。
GitHubとドキュメント作成ツールを連携し、PDF生成を自動化することで、<span class="mark-yellow">これまで手作業で行っていたプルリクエストの内容をまとめるレポート作成などの手間を削減し、ヒューマンエラーを防ぐことができます。</span>
これにより、開発者はドキュメンテーション作業から解放され、本来のコア業務である開発活動により一層集中できる環境が整うでしょう!
今回ご紹介したような業務自動化を実現できるノーコードツール「Yoom」を使えば、プログラミングの知識がない方でも、直感的な操作で簡単に業務フローを構築可能です!
もし自動化に少しでも興味を持っていただけたなら、ぜひこちらの登録フォームから無料登録して、Yoomによる業務効率化を体験してみてください!
Q:プルリクエスト以外のGitHubアクションでも自動化できますか?
A:はい、できます。
例えば、GitHubアクションをIssueが新しく作成されたらなどに変更可能です。
GitHubアクションは、ステップ3の以下の箇所で変更できます。
下記画像の変更をクリックし、表示されたアクションの中から選択してください。
GitHubの他のアクションについては下記リンクをご確認ください。

Q:Googleドキュメント以外でPDFを作成できますか?
A:はい、できます。
今回と同様に雛形を利用してPDFを作成する場合は、Google スプレッドシートやMicrosoft Excelを利用して作成することも可能です。
運用内容に合わせて、お好みでカスタマイズしてください。

Q:自動化の途中でエラーが発生した場合はどうなりますか?
A:運用中にエラーが発生した場合は、Yoomにご登録いただいているメールアドレスへ通知が届きます。
通知メールには、エラーが起きている箇所や詳細のリンクが記載されておりますのでご確認ください。
また、再実行は自動で行われません。エラー修正後に手動で再実行してください。

