GitBucketのPages pluginを改造した話

2017.03.15

mentaiko

プログラム

はじめに

弊社ではソース管理にGitBucketを利用していて、いくつかプラグインも導入しています。

GitBucketを補助するプラグイン4選

この中のGitBucket Pages pluginを導入するとGitHub PagesのようにGitリポジトリを静的なウェブページをホスティングすることができます。ですが、当初のGitHub Pagesのようにgh-pagesブランチとgb-pagesブランチだけしかホスティングされませんので、reveal.jsやswagger-uiのようにサーバに配置するだけで動作するWebアプリだとブランチを変更する必要があります。
そこで現在のGitHub Pagesのようにホスティングするブランチを選択できるように改造してみました。

開発版
- https://github.com/shiena/gitbucket-pages-plugin/tree/pages-option
GitBucket 4.10で動作確認済みのもの
- https://github.com/shiena/gitbucket-pages-plugin/tree/pages-option-4.10

追加した機能

この画面のようにSettingsにPagesタブを追加してホスティングするブランチを選択できるようにしました。機能面ではこれだけなのですが、設定を保存するためにテーブル、モデルクラス、サービスクラスを追加していったので元のコードサイズの2倍近くになってしまいました。

困ったこと

画面と設定反映まで作ったところで気付いたのですが、リポジトリ名を変更したり、オーナーを変更してもプラグイン側からは分からないのでテーブルに反映できない事に気付き困ってしまいました。
そこでテーブルの代わりにリモートリポジトリのgit configに設定を保存したのが上述した、「GitBucket 4.10で動作確認済みのもの」です。

とは言え、サーバーの設定をファイルに保存するのは気持ち悪いものです。
そんな事をTwitterでつぶやいていたら作者のTakezoeさんがプラグインのためのフックポイントを追加してくれました。これを利用したものが上述した、「開発版」です。