gollum で使用されるデフォルトブランチは main ではなく master なので注意されたし

これは何？

• https://github.com/gollum/gollum を使って Wiki を構築した際に、なんか挙動が変だなと思って調べたメモ

結論

• gollum ではデフォルトブランチが main ではなく master なので、オプションやコンフィグファイルで ref パラメーターで main ブランチを指定すると良い
• 個人的には公式 Docker イメージで動かしているため、以下のような --ref オプション指定で解決した
  • docker run --rm -p 4567:4567 -v $(pwd):/wiki gollumwiki/gollum:master --ref main

どういうことか

• https://github.com/gollum/gollum は git ベースの Wiki
• 昨今の git や git を使用するサービスのデフォルトブランチは master ではなく main となっている
  • https://sfconservancy.org/news/2020/jun/23/gitbranchname/
  • https://github.blog/changelog/2020-10-01-the-default-branch-for-newly-created-repositories-is-now-main/
  • https://about.gitlab.com/blog/2021/03/10/new-git-default-branch-name
  • https://bitbucket.org/blog/moving-away-from-master-as-the-default-name-for-branches-in-git
  • https://docs.aws.amazon.com/codecommit/latest/userguide/history.html
• gollum は master をデフォルトブランチとしているため main ブランチを使用するのであれば指定が必要
  • https://github.com/gollum/gollum/issues/1813 によると、デフォルトブランチの変更によって既存環境に問題が発生することを懸念している状況？
• gollum ではコマンドオプションやコンフィグファイルによって使用するブランチを指定できるので、これらで main ブランチを指定すれば良い
  • コマンドオプションなら --ref で指定する
    • https://github.com/gollum/gollum#configuration
    • gollum --ref main ./
    • docker run --rm -p 4567:4567 -v $(pwd):/wiki gollumwiki/gollum:master --ref main
  • コンフィグファイルなら ref:
    • https://github.com/gollum/gollum/wiki/Sample-config.rb

試した環境

ローカル環境

$ sw_vers
ProductName:	macOS
ProductVersion:	12.3.1
BuildVersion:	21E258
$ ruby -v
ruby 2.6.8p205 (2021-07-07 revision 67951) [universal.x86_64-darwin21]
$ gollum -v
Gollum 5.2.3

Docker Image

• https://hub.docker.com/layers/gollum/gollumwiki/gollum/master/images/sha256-97b7c5f3cf4d37f1e0707958b173a3afebcfeed070bd6c49a3c10f9f3de65ef7
• master しかタグが作成されていないため、一意性は DIGEST を確認する必要あり...