私は、これはすべてのかなり退屈見つける - 私の意見では、githubのウィキがメインリポジトリの枝である必要があり、あるいは少なくともオプションであることにすることが可能でなければなりません。
それでも、私は最善の解決策は、メインリポジトリに単に移動ウィキにあると信じて、subtree mergeを使用して、docs/
またはwiki
で言います。たとえば、リポジトリがyou/proj
であると仮定すると、あなたのwikiは:git://github.com/you/proj.wiki
になります。あなたが合うようにあなたのメイン文書にその後、獣医それらを
git clone git://github.com/you/proj
cd proj
git remote add -f wiki git://github.com/you/proj.wiki
git merge -s ours --no-commit --allow-unrelated wiki/master
git read-tree --prefix=wiki/ -u wiki/master
git commit -m "Github wiki subtree merged in wiki/"
あなたも、そこに公共の貢献を歓迎する側での作業のwikiを保つことができますが、:その後、あなたのメインのレポでそれをマージするために、あなたが行うだろう。後のレビューに新しい変更をマージするには、あなたがどうなる:
git pull -s subtree wiki master
残念ながら、マージは、他の方法がややトリッキーで変化し、そしてとにかく、あなたはおそらく1時間の事としてこれを行う必要があり、その後、ウィキを閉じて、レポソースにリダイレクトする...
さらに、このアプローチの主な注意点は、git log wiki/Home.md
(たとえば)は実際にはwikiページの履歴を表示しないということです。履歴はですが、なんとかgit-log
はそれを追跡できません。これはgitサブツリーに関連するknown limitationです。これを修正するもう1つの解決方法は、filter-branch
を実行し、履歴を保存するための1回の通常のマージを行うことです。私にとって
、メインのソースツリーの一部としてウィキを持つことの主な利点は、プル要求および変更はコードとドキュメント間で協調することができるということです。また、人々は単にオンラインで読むことを前提とするのではなく、コードをドキュメントに添付するのが簡単です。
私はサブモジュールと一緒に行きました。答えをありがとう。 –
wikiをサブモジュールとしてどのようにあなたのために行くのですか?私は似たようなことをしたいが、サブモジュールビジネスの周りに頭を包んでいない。これは分岐とマージにどのように対処しますか?私はwikiのために同じコードを "開発する"ブランチを持っていたいので、それを私のマスターブランチとマージすると、ライブウィキブランチ。 –
しかし、それをサブモジュールとして持つのは何ですか?とにかくそれを変更したり使用したりすることはできません。あなたはgithubの外のどこでもそれを使用できますか?私はあなたがgithubリポジトリとは別のディレクトリにそれを持つことができ、単にメインリポジトリからそのディレクトリを削除することを意味します。 – jayarjo