APC 技術ブログ

株式会社エーピーコミュニケーションズの技術ブログです。

株式会社 エーピーコミュニケーションズの技術ブログです。

BackstageでGitHub リポジトリの状況を見る

Backstageの紹介

これまで何度かBackstageについてご紹介してきました。

techblog.ap-com.co.jp

Backstageは簡単にいえば開発チーム向けのInternal Developer Portal(IDP)です。 Platform EngineeringにおいてもIDPを活用するのがよいということも言われています。

では、実際どういったことができるのか。

Backstageでは様々な機能をPluginとして拡張できます。開発チーム向けということでGitHubとの連携機能についても様々なものがWebサイトリポジトリを通じて公開されているため、独自に開発することなく必要な連携を実現することができます。

今回はその一端をGitHubとの連携を例にご紹介したいと思います。

GitHubとの連携

リポジトリのOverview

GitHubの各種サービス、例えばGitHub ActionsやIssues、PullReqesutの状態などを確認するとき、どのように行っていますか。通常はGitHub上のそれぞれのページに遷移して確認していたと思います。Backstageではそうした情報を1つの画面内でサマリーをまとめて見ることができます。

AboutはBackstage内に登録したリポジトリの属性情報ですが、「View Source」からGitHubのリポジトリに遷移することもできます。 そして「Dependabot alert」や「「Open GitHub Issues」のウィジットでそれぞれの状況が確認できるようになっています。またこの例では「GitHub Pull Request Statistics」でPull Requestを通じたリポジトリのメトリックスを表示しています。

こうした情報を一括して見ることができるようになるのがポータルと呼ばれる所以です。

もちろんGitHubだけではなく、その他のサービスのウィジットもこの画面で表示することができます。わざわざ各サービスにいかなくてもサマリーはここを見れば確認できる、という状態なのが良い点です。

Pull Request一覧

PULL REQUESTタブではオープン状態にあるPull Requestの一覧を確認できます。処理していないPull RequestをGitHubに遷移することなく確認できるようになります。

GitHub Issuesの一覧

同じようにIssueの一覧も表示可能です。Overviewの情報よりもより多く確認したい場合はここで見ればOK。

GitHub Actionsの一覧

GitHub Actionsの結果一覧も表示できます。多くの開発チームではActoinsの実行結果はSlack等で表示しているのではないでしょうか。リアルタイムの状況を見るのはSlackなどのツールが優れています。しかし、いくつもの実行状態を確認したい場合もあるので、そうした場合はBackstageで確認すればOKです。

Dependabot alert一覧

さらにDependabot alertの一覧も表示できます。対応漏れなどがないよう、こうした情報をすぐに確認できるような状態になっていることが望ましいのではないでしょうか。

まとめて確認できる利点

1つのリポジトリだけであれば、上記のような情報はGitHub上で確認すればよいとも思います。しかし複数のリポジトリがあった場合はどうでしょうか。自分が関与する複数のリポジトリに遷移してひとつひとつサービス画面を表示するのは手間がかかります。 Backstageであれば、サービス(Service Catalog)の一覧からすぐにこうした情報を確認できます。

開発を進めていく上で情報アクセスの容易性は非常に重要で、簡単であれば毎日でも継続できますが、面倒なものとなると利用されなくなります。Backstageで様々なPluginを組み合わせて情報の一覧性を高め、少しでも簡単にアクセスできるようにするとよいのではないかと考えています。

ACS事業部のご紹介

私たちACS事業部はAzure・AKSなどのクラウドネイティブ技術を活用した内製化のご支援をしております。 Platform Engineering/Backstage導入支援もこうした内製化支援の一部と考えております。ぜひお声がけください。

www.ap-com.co.jp