help を sakura リポジトリからの参照方式の構築にする (submodule or subtree)

[kobake]

ファイル内容が sakura リポジトリ内の help と被っていて二重管理になっているので、sakura リポジトリ側を管理主体と考え、Web (本リポジトリ) では sakura リポジトリの help 内容を参照する形に構築し直す。

手段としては submodule または subtree が考えられる。

• subtree についてはうまく動くことを検証済み。
• submodule についても追って検証予定。
• シンボリックリンクの仕組みも使えることは検証済みなので、これも組み合わせると良さそう。

対応タイミング

sakura 側のヘルプ構造がある程度確定してから対応することを考えています。

[KENCHjp]

これイケそうっすかね？

手段としては submodule または subtree が考えられる。

これがよくわからずww

[berryzplus]

submodule は他のリポジトリを自分のリポジトリの一部みたいに取り込む機能らしいです。
subtree は使ったことないのでよく分らんです。

sakura-editor/sakura だと googletest が submodule になってるはず・・・。

[m-tmatma]

ちなみに submodule は使用する git hash を指定できるので、公開するバージョンをコントロールできると思います。

subtree は全く知らないです

[k-takata]

subtreeに関してはこれとかがいいかと。

• Git Submodule の代替: Git Subtree | Atlassian Blogs
• Git subtree のパワー | Atlassian Blogs

subtreeは現在のリポジトリの一部として完全に取り込んでしまうので、cloneすればすぐに使えるのは便利ですね。checkoutのたびにわざわざ git submodule update する必要もありません。
あとは、subtreeとして取り込んだものを少し改造して使いたいような場合にも、だいたいうまい具合にupstreamの変更をマージしてくれるので便利ですね。

[k-takata]

• 取り込んだサブリポジトリは、あくまで本体とは別物として明確に分けて管理したい → submodule
  • git submodule update 等の手間が必要
• 取り込んだサブリポジトリは、本体と一体管理したい → subtree
• 取り込んだサブリポジトリに手を加えて使いたい → subtree
• 使いたいサービスが submodule に対応していない → subtree

なお、subtreeはupstreamのリポジトリを記憶してくれないので、upstreamからpullするための専用のスクリプトを用意しておくと便利です。例:

#!/bin/sh
git subtree pull --prefix "ローカルディレクトリ" "upstreamのURL" master --squash

[KENCHjp]

https://github.com/sakura-editor/sakura-editor.github.io/blob/master/README.md

subtreeについては、ここにメンテナンス方法のメモ残しとくとよいかなと。

[berryzplus]

対応タイミング
sakura 側のヘルプ構造がある程度確定してから対応することを考えています。

この話題はこれが原因で止まってる感じなのかな？
追加機能に関する追記はマメにやれてると思ってますが、
構造整理はほぼ手つかずのような気がします。

構造整理をしなくちゃ、ってところから始めるべきですかね。

[m-tmatma]

リリースするならこれの検討をしたほうがいいです。

[KENCHjp]

＞リリースするならこれの検討をしたほうがいいです。

現在の正式リリースのインストーラーより悪くなるならば再優先かなと、
もし放置した場合に、exeとの矛盾が生じるというのであれば、この際優先度落としてもいいかなと。
もちろんいろんなものに矛盾がないのは正しくあるべき姿かと思いますし、リリースする場合にクリアする課題をつぶすことも一つの成果ではあると思いますが、このあたりのバランスで拾うものと先送りするものを決めていきたいかなと思います。

[m-tmatma]

web サイトと同梱のヘルプで、相違があるので合わせないと混乱を招くと思います。

最悪、本体側の html をローカルでこちらのリポジトリに手動で取り込み、コミットしてもいいと思います。

[KENCHjp]

最悪、本体側の html をローカルでこちらのリポジトリに手動で取り込み、コミットしてもいいと思います。

了解です。

https://github.com/sakura-editor/sakura/tree/master/help/sakura/_RESOURCE
を
sakura-editor.github.io/help/へコミットってことっすかね。

[berryzplus]

検討をしようって話なら具体案が欲しいです。時間かかりそうなので後回しにしたいですが、

とりあえず最新化しとく必要があるよねーって話なら同意です。PR入れてもらえればサクッと終わると思います。

[KENCHjp]

とりあえず最新化しとく必要があるよねーって話なら同意です。

今後ダブルメンテは解消したいので、後々は何か仕組みをつくるのか、運用方法を決めるといいのかなと思いますが、とりあえず最新化しとくかなと。
こちらも一旦ブランチ切って、本体リリース時に同時にリリースって感じですかね。

[m-tmatma]

最悪、本体側の html をローカルでこちらのリポジトリに手動で取り込み、コミットしてもいいと思います。

了解です。

https://github.com/sakura-editor/sakura/tree/master/help/sakura/_RESOURCE
を
sakura-editor.github.io/help/へコミットってことっすかね。

#47 を作りました。

[m-tmatma]

2.4.0 はリリース済みで、web と sakura-editor の本体は同期している状態