リビルド時、githash.hが再生成されるように修正

[berryzplus]

PR の目的

リビルド時にgithash.hを再作成して、更新されるようにします。

カテゴリ

• ビルド関連
  • ビルド手順

PR の背景

Git clone後にビルドして、 githash.h が生成された状態にすると、
pullしてソースを最新にしても githash.h が更新されないようです。
#1750 (comment)

PR のメリット

リビルド時にgithash.hが再生成されるようになります。

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

リビルド時にgit情報の変更がなくてもgithash.hが再生成されてしまいます。

仕様・動作説明

リビルド時にgithash.hが再生成されるように、
クリーン時にgithash.hを削除するビルドタスクを追加します。

PR の影響範囲

通常のビルド（≒MinGWビルド以外）に影響する変更です。
アプリの機能には影響を与えないと考えられます。

テスト内容

テスト1

手順
ソリューションをビルドする。　→githash.hが生成されたことを確認。
ソリューションをクリーンする。　→githash.hが削除されたことを確認。
ソリューションをクリーンする。　→githash.hが存在しなくてもエラーにならないことを確認。
ソリューションをリビルドする。　→githash.hが生成されることを確認。

関連 issue, PR

参考資料

追加するタスクは sakura.vcxproj からコピペして作成しました。

sakura/sakura/sakura.vcxproj

Lines 957 to 964 in 42568b8

	<Target Name="AppendCleanTargets" BeforeTargets="CoreClean">
	<!-- Add files to @Clean just before running CoreClean. -->
	<ItemGroup>
	<Clean Include="$(OutDir)sakura.ini" />
	<Clean Include="$(OutDir)bregonig.dll" />
	<Clean Include="$(OutDir)ctags.exe" />
	</ItemGroup>
	</Target>

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[AppVeyorBot]

✅ Build sakura 1.0.3978 completed (commit 15dd34f9ff by @berryzplus)

[beru]

Name が重複しているので変えた方が上書きされないので良いと思います。

このファイル sakura/githash.targets ですが複数のプロジェクトからImportされています。

• sakura/sakura.vcxproj
• sakura_lang_en_US/sakura_lang_en_US.vcxproj

このうちsakuraプロジェクト用の sakura/sakura.vcxproj では <Import Project="..\sakura\githash.targets" /> の記述の後方に下記の記述が存在します。

  <Target Name="AppendCleanTargets" BeforeTargets="CoreClean">
    <!-- Add files to @Clean just before running CoreClean. -->
    <ItemGroup>
      <Clean Include="$(OutDir)sakura.ini" />
      <Clean Include="$(OutDir)bregonig.dll" />
      <Clean Include="$(OutDir)ctags.exe" />
    </ItemGroup>
  </Target>

これで上書きされるので、sakuraプロジェクトをCleanしても sakura/githash.h ファイルが削除されません。ただし sakura_lang_en_USプロジェクト側でカバーされるので、Clean SolutionやRebuild Solution時には問題は起きません。という事で半ば動きはするので実質的に問題は無いとは言えます。

---

https://github.com/berryzplus/sakura/blob/e4ee7c208897de37c4d09776fa3e76e00c18336e/sakura/sakura.vcxproj#L944

https://github.com/berryzplus/sakura/blob/e4ee7c208897de37c4d09776fa3e76e00c18336e/sakura/sakura.vcxproj#L957-L964

[berryzplus]

動いてそうですが、それでも問題ありますか？

[ghost]

プロジェクトごとにビルド/クリーンしているような場合は大丈夫なんでしょうか？

[beru]

SolutionではなくsakuraプロジェクトをCleanした際に sakura/githash.h ファイルが削除されない事は簡単に確認出来ます。

色々な条件で確認せずになんとなく動いてそうと判断して不完全さが残るお約束というか様式美を体現する芸風に感じ入るところはあるのでApproveしておきます。

[berryzplus]

PRを撤回します。