GitHub Pages でハマった話

久々に技術系のエントリ。

ずっと開発してきた2画面ファイラ「farman」。
まだまだ完成というには程遠いが、それなりに機能も充実してきたし、そろそろバイナリを公開することにしようと考えた。
公開するためにまず Web サイトを作ろうと思い立ったが、そのためにわざわざサーバ借りたりするのは面倒だし、金もかかる。
そこで、ソースコードを置いている GitHub で、Web サイトを公開できる機能である GitHub Pages を使うことにした。

GitHub Pages で Web サイトを構築するには、
  1. master ブランチ
  2. master ブランチに docs というフォルダを作る
  3. gh-pages ブランチ
の3通りの方法がある。
今回、1及び2については、master ブランチにアプリのソースコードのコミットと Web サイトのコミットが混在することになってしまうので、3の gh-pages ブランチを作ることにした。

GitHub のサイト上で gh-pages ブランチを作り、Settings に入ったところ、GitHub Page のところで↓のような感じのエラーメッセージが。(スクショ撮り忘れたので他のサイトのを拝借)
リンク先を見てみると、サブモジュールが無効なのでビルドが出来ない == Web サイトが公開できない、ということらしい。
farman ではバイナリビュアーのために「QHexView」というバイナリビュアーを fork して多少改造した上で farman のサブモジュールとしているのだが、どうもその QHexView が参照できないようだ。
リンク先の内容を Google 翻訳の力を借りながら読み進めていくと、どうやら .gitmodule に記述するサブモジュールの参照方法が ssh だとダメで、https:// で記述しないといけないようだ。

ということで、この commit で無事解決した。
一度知ってしまえばなんてこと無い問題だが、知らないとハマりそうな問題である。

ちゃんと設定できると、↓のように Web サイトの URL が表示される。
スクリーンショット 2019-07-30 0.12.12.png
とりあえず、ちゃんと Web サイトを見ることができるか、テストで index.html を書いて gh-pages ブランチに commit & push してみた。


CSS すら書いてないので、インターネット黎明期の頃のサイトのようだw
正直デザイン関係は苦手なのだが、似たようなアプリであるこれとかこれあたりを参考にして、なるべく早い時期に公開できるようにしたい。

この記事へのコメント