HTML ヘルプ内部の フォルダパスを変更することで #906 (HTML help のビルドに失敗する問題)を修正する。

[m-tmatma]

PR の目的

HTML ヘルプ内部の フォルダパスを変更することで #906 (HTML help のビルドに失敗する問題)を修正する。

カテゴリ

• 不具合修正

PR の背景

• 最近高確率で Azure Pipelines で HTML Help のビルドに失敗している。
• Appveyor でも以前から 同様の問題が発生していた (appveyor ビルドで build-sln.bat がたまに失敗する #584)

PR のメリット

#906 を修正する

PR のデメリット (トレードオフとかあれば)

PR の影響範囲 と同じ

PR の影響範囲

• 生成される chm ファイル内部のパスが変わるが、内部的なものにとどまり、ユーザーには影響しない。
• [WIP] HTML ヘルプの文字コードを UTF-8 BOM 付きに変換する #807 とコンフリクトする。([WIP] HTML ヘルプの文字コードを UTF-8 BOM 付きに変換する #807 は試行錯誤の跡が多くわかりにくいので本PR がマージされたら作成しなおします)

関連チケット

• [WIP] HTML ヘルプの文字コードを UTF-8 BOM 付きに変換する #807
• close Azure Pipelines で HTML help のビルドに失敗する #906
• [WIP] #906 の修正のために sakura.chm 内部のパス名変更 #920
• Pull Request Template を導入する #918
• sakura リポジトリの HTML のヘルプ (help\sakura\_RESOURCE) を help に取り込む sakura-editor.github.io#47
• [WIP] HTML ヘルプの文字コードを UTF-8 BOM 付きに変換する #807

参考資料

[m-tmatma]

#920 (comment)
で効果があることは確認済み。

[m-tmatma]

この PR でも通った。
(https://dev.azure.com/sakuraeditor/sakura/_build/results?buildId=466)

[berryzplus]

問題なさそうに思うのでやったらいいと思います。
実質的に help/sakura 全体に影響する変更なので second opinion を希望します。

[berryzplus]

「second opinionを希望します。」と書いたものの、内容がそれなりに重たいので自分なりの見解を添えてapproveした上で「後は任せる」の方針に切り替えようと思います。

おさらい

• PRの目的 ・・・ 最近頻発しているAzule Pipelinesでのビルドエラーを回避する。
• PRの内容 ・・・ パスに"_"を含むフォルダをリネームする。
• PRの根拠 ・・・ 試しにリネームしてみたら10回連続でビルドできた。(#920で実験して確認している。)
• PRの弊害 ・・・ 既にPR中の(または、将来PRされるであろう) sakura-editor/help への変更すべてと競合する。例えば [WIP] HTML ヘルプの文字コードを UTF-8 BOM 付きに変換する #807 の文字コード変更PRは作りなおしが必要になる。

変更内容のサマリ

このPRの変更内容は、ざっくりと3種類に分類できます。

No.	変更内容の種類	対象ファイル数
1	親フォルダのパスが変更になる	477ファイル
2	パスを記述するファイルなので変更する必要がある	3ファイル
3	親フォルダのパスが変更になる + 例示の中にあるパスのサンプルを変更	1ファイル

例示の中にあるパスのサンプルの変更に関しては、必須ではないです。
このPRの採否で意見が分かれるとしたらこの点のみかと思います。

個人的には「変えておいたほうがわかりやすい」と思っています。

[berryzplus]

メモ：個人的には変えといたほうが分かりやすいと思います。

[m-tmatma]

修正しました。

[m-tmatma]

この PR はおそらくビルドエラーには関係ない

[berryzplus]

必要だから変更した、を、必要なくなったから元に戻す、のは理に適ってると思います。
元に戻すべきだ、とまでは思っていませんが、revert作業にあたって都合が悪ければいったん元に戻してもいいんじゃないかと思います。そのあたりは臨機応変に 😄