Appveyor 専用の環境変数を汎用的なものに定義しなおして azure pipelines で使えるようにする

[m-tmatma]

PR の目的

#821 Appveyor 専用の環境変数を汎用的なものに定義しなおして azure pipelines で使えるようにする

カテゴリ

• CI関連
  • Appveyor
  • Azure Pipelines

PR の背景

#821 Appveyor 専用の環境変数を汎用的なものに定義しなおす

#1180 (comment)

ガッツリ変更したい場合はカウンターオファー出してもらったほうが対応しやすいです。

名前が変わるもの

意味/用途	変更後	変更前	Azure Pipelines のネイティブ変数
リポジトリ名	CI_REPO_NAME	APPVEYOR_REPO_NAME	BUILD_REPOSITORY_NAME
CI のアカウント名	CI_ACCOUNT_NAME	APPVEYOR_ACCOUNT_NAME	BUILD_DEFINITIONNAME
ビルド番号 (数値)	CI_BUILD_NUMBER	APPVEYOR_BUILD_NUMBER	BUILD_BUILDID ※注意
ビルド番号用のラベル	CI_BUILD_NUMBER_LABEL	APPVEYOR_BUILD_NUMBER_LABEL	-
ビルドバージョン(文字列)	CI_BUILD_VERSION	APPVEYOR_BUILD_VERSION	BUILD_BUILDNUMBER ※注意
ビルドへの URL	CI_BUILD_URL	APPVEYOR_BUILD_URL	-
PR の HEAD リビジョン	GITHUB_PR_HEAD_COMMIT	APPVEYOR_PULL_REQUEST_HEAD_COMMIT	SYSTEM_PULLREQUEST_SOURCECOMMITID
PR の HEAD リビジョン短縮形	GITHUB_PR_HEAD_SHORT_COMMIT	APPVEYOR_SHORTHASH_PR_HEAD	-
PR 番号 (数値)	GITHUB_PR_NUMBER	APPVEYOR_PULL_REQUEST_NUMBER	SYSTEM_PULLREQUEST_PULLREQUESTNUMBER
PR 番号用のラベル	GITHUB_PR_NUMBER_LABEL	APPVEYOR_PR_NUMBER_LABEL	-
Build URL のラベルの ID	IDC_STATIC_URL_CI_BUILD	IDC_STATIC_URL_APPVEYOR_BUILD	-
GitHub URL のラベルの ID	IDC_STATIC_URL_CI_BUILD_CAPTION	IDC_STATIC_URL_APPVEYOR_CAPTION	-
開発バージョンかのフラグ	DEV_VERSION	APPVEYOR_DEV_VERSION	-

名前は変更せずに定義が変わるもの

意味/用途	変数
GitHub のコミット URL	GITHUB_COMMIT_URL

注意

appveyorのビルド番号(APPVEYOR_BUILD_NUMBER) の azure pipeline での counterpart は BUILD_BUILDID であり、BUILD_BUILDNUMBER ではないことに留意する必要がある。

appveyorのビルドバージョン(APPVEYOR_BUILD_VERSION) の azure pipeline での counterpart が BUILD_BUILDNUMBER である。

PR のメリット

• 環境変数の汎用定義が完了し、azure pipelines でも使えるようになる

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

• ドキュメント修正は後でやります。

PR の影響範囲

• azure pipelinesのビルドで appveyor でできていた環境変数に依存する処理を利用できるようになる

関連チケット

#821 Appveyor 専用の環境変数を汎用的なものに定義しなおす 参照
#1184
#1185
#1186
#1187

参考資料

https://www.appveyor.com/docs/environment-variables/
https://docs.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml

[m-tmatma]

PR 関係の変数が動作未確認なので Draft Pull Request にした。

[m-tmatma]

SYSTEM_TEAMPROJECTと APPVEYOR_PROJECT_SLUGは共通の変数にできそう。

[m-tmatma]

SYSTEM_TEAMPROJECTと APPVEYOR_PROJECT_SLUGは共通の変数にできそう。

でも外向けにはなくても困らない変数

[AppVeyorBot]

✅ Build sakura 1.0.2590 completed (commit 7ce04cb2ff by @m-tmatma)

[m-tmatma]

PR 関係の変数が動作未確認なので Draft Pull Request にした。

PR 関係の変数の動作確認できたので Draft Pull Request を解除します。

[AppVeyorBot]

✅ Build sakura 1.0.2591 completed (commit 377d86178b by @m-tmatma)

[AppVeyorBot]

✅ Build sakura 1.0.2592 completed (commit fb62b61f52 by @m-tmatma)

[m-tmatma]

リファクタリングを含んでいるために、レビューしにくいので
リファクタリング部分を #1184 として分離しました。

[m-tmatma]

この PR は単独で完了していますが、
修正が大きいので、必要に応じて分割しようと思います。

[m-tmatma]

修正が大きいので、必要に応じて分割しようと思います。

まず #1184 を先にマージしました。
さらに分割するかは思案中

[m-tmatma]

さらに分割するかは思案中

変数の汎用化対応と azure pipelines 対応がコミットごとにきれいにわかれていないので
ちょっとめんどくさい、

一気にやるんじゃなかったかも

[m-tmatma]

変数の汎用化対応と azure pipelines 対応がコミットごとにきれいにわかれていないので
ちょっとめんどくさい、

汎用化対応と azure pipelines 対応でコミットを一部分けた。
でも変数の名前を途中で変えたりして一部わかりにくいところはある。

[AppVeyorBot]

✅ Build sakura 1.0.2598 completed (commit 45417cb9d6 by @m-tmatma)

[AppVeyorBot]

✅ Build sakura 1.0.2599 completed (commit 45417cb9d6 by @m-tmatma)

[AppVeyorBot]

✅ Build sakura 1.0.2600 completed (commit 0c92c420c0 by @m-tmatma)

[AppVeyorBot]

✅ Build sakura 1.0.2601 completed (commit 690c4a7ed4 by @m-tmatma)

[AppVeyorBot]

✅ Build sakura 1.0.2602 completed (commit 2340a7e900 by @m-tmatma)

[AppVeyorBot]

✅ Build sakura 1.0.2603 completed (commit 60e0ae4e3c by @m-tmatma)

[m-tmatma]

PR の分割は完了。この PR のレビューお願いします。

[AppVeyorBot]

✅ Build sakura 1.0.2614 completed (commit eec7d9a00f by @m-tmatma)

[berryzplus]

PRのレビュー結果には関係しませんが、気付いたことのメモです。

appveyor のビルドログ

---- Make githash.h ----
checking GIT_SHORT_COMMIT_HASH, GIT_COMMIT_HASH
GIT_SHORT_COMMIT_HASH : eec7d9a
GIT_COMMIT_HASH       : eec7d9a00fe0f226dc245daa47a81a09b651e65e
TEMP_GIT_SHORT_COMMIT_HASH : eec7d9a
TEMP_GIT_COMMIT_HASH       : eec7d9a00fe0f226dc245daa47a81a09b651e65e
GIT_REMOTE_ORIGIN_URL : https://github.com/sakura-editor/sakura.git
GIT_TAG_NAME          : 

CI_REPO_NAME          : sakura-editor/sakura
CI_ACCOUNT_NAME             : sakuraeditor
CI_BUILD_VERSION            : 1.0.2614
CI_BUILD_NUMBER             : 2614
CI_BUILD_URL                : https://ci.appveyor.com/project/sakuraeditor/sakura/build/1.0.2614

GITHUB_COMMIT_URL           : https://github.com/sakura-editor/sakura/commit/eec7d9a00fe0f226dc245daa47a81a09b651e65e
GITHUB_COMMIT_URL_PR_HEAD   : https://github.com/sakura-editor/sakura/pull/1183/commits/63f6683199a96ddc41d3b34d3d82add248ddfc81
GITHUB_PR_HEAD_COMMIT       : 63f6683199a96ddc41d3b34d3d82add248ddfc81
GITHUB_PR_HEAD_SHORT_COMMIT : 63f66831

APPVEYOR_URL          : https://ci.appveyor.com
APPVEYOR_PROJECT_SLUG : sakura
        1 file(s) moved.
..\sakura_core\githash.h was updated.

• GIT_SHORT_COMMIT_HASH 7文字。
• GIT_COMMIT_HASH 多分フル桁。
• TEMP_GIT_SHORT_COMMIT_HASH : 8文字。なんで？
• TEMP_GIT_COMMIT_HASH フル桁と同じものな気がする。
• TEMP_GIT_XXXってなんでしたっけ？ｗ
• CI_XXX のグループとGITHUB_XXX のグループは、出力順を入れ替えたほうが見やすくなる気配です。
• CI_REPO_NAME は GITHUB_REPO_NAME な気がする。
• GITHUB_COMMIT_URL_PR_HEAD を GITHUB_PR_HEAD_URL にしたら GITHUB_PR_HEAD_ の頭が揃うような。
• GITHUB_PR_HEAD_COMMIT ⇒ GITHUB_PR_HEAD_COMMIT_HASH （似た名前の変数に合わせる）
• GITHUB_PR_HEAD_SHORT_COMMIT ⇒ GITHUB_PR_HEAD_SHORT_COMMIT_HASH （似た名前の変数に合わせる）
• GITHUB_XXX のグループ内の並び順が、コミットハッシュ⇒URLの順だと分かりやすい気配です。

これ書いてどうする？ってのは考えてませんでしたが、
出力をきれいに揃えてみて初めて見えてくる気付きもあるのかな？と思ってます。

[berryzplus]

見た感じ、問題なさそうな（＝関係ない変更はしてなさそうな）。

ドキュメントをちゃんとレビューできる自信はないっす。

おいらはどうも、難しいものを難しいまま理解する傾向にあるので、
ドキュメント系のレビューに向いとらん気がするのです。

難しい概念とかややこしい概念とかを平易な言葉で分かりやすくまとめるのがドキュメント化なはずです。

平易な言葉じゃなくても、まっとまってなくても、
なんとなく行間を読んで分かった気になれる性格なので、
一般的な「わかりやすい」の感覚がずれとるんですよ...orz

[berryzplus]

w

たぶんなんも間違ってないと思いますが、表現が面白かったっす 😃

[berryzplus]

(ほぼ独り言) CI_REPO_NAME というよりは GITHUB_REPO_NAME なんじゃないかな？とか 😄

[m-tmatma]

#1187 で修正した変数に関係するのですが
ci の観点からすると、ソースを管理するリポジトリは
github とは限らないので、そうしてます

[m-tmatma]

PRのレビュー結果には関係しませんが、気付いたことのメモです。

appveyor のビルドログ

---- Make githash.h ----
checking GIT_SHORT_COMMIT_HASH, GIT_COMMIT_HASH
GIT_SHORT_COMMIT_HASH : eec7d9a
GIT_COMMIT_HASH       : eec7d9a00fe0f226dc245daa47a81a09b651e65e
TEMP_GIT_SHORT_COMMIT_HASH : eec7d9a
TEMP_GIT_COMMIT_HASH       : eec7d9a00fe0f226dc245daa47a81a09b651e65e
GIT_REMOTE_ORIGIN_URL : https://github.com/sakura-editor/sakura.git
GIT_TAG_NAME          : 

CI_REPO_NAME          : sakura-editor/sakura
CI_ACCOUNT_NAME             : sakuraeditor
CI_BUILD_VERSION            : 1.0.2614
CI_BUILD_NUMBER             : 2614
CI_BUILD_URL                : https://ci.appveyor.com/project/sakuraeditor/sakura/build/1.0.2614

GITHUB_COMMIT_URL           : https://github.com/sakura-editor/sakura/commit/eec7d9a00fe0f226dc245daa47a81a09b651e65e
GITHUB_COMMIT_URL_PR_HEAD   : https://github.com/sakura-editor/sakura/pull/1183/commits/63f6683199a96ddc41d3b34d3d82add248ddfc81
GITHUB_PR_HEAD_COMMIT       : 63f6683199a96ddc41d3b34d3d82add248ddfc81
GITHUB_PR_HEAD_SHORT_COMMIT : 63f66831

APPVEYOR_URL          : https://ci.appveyor.com
APPVEYOR_PROJECT_SLUG : sakura
        1 file(s) moved.
..\sakura_core\githash.h was updated.

• GIT_SHORT_COMMIT_HASH 7文字。
• GIT_COMMIT_HASH 多分フル桁。
• TEMP_GIT_SHORT_COMMIT_HASH : 8文字。なんで？
• TEMP_GIT_COMMIT_HASH フル桁と同じものな気がする。
• TEMP_GIT_XXXってなんでしたっけ？ｗ
• CI_XXX のグループとGITHUB_XXX のグループは、出力順を入れ替えたほうが見やすくなる気配です。
• CI_REPO_NAME は GITHUB_REPO_NAME な気がする。
• GITHUB_COMMIT_URL_PR_HEAD を GITHUB_PR_HEAD_URL にしたら GITHUB_PR_HEAD_ の頭が揃うような。
• GITHUB_PR_HEAD_COMMIT ⇒ GITHUB_PR_HEAD_COMMIT_HASH （似た名前の変数に合わせる）
• GITHUB_PR_HEAD_SHORT_COMMIT ⇒ GITHUB_PR_HEAD_SHORT_COMMIT_HASH （似た名前の変数に合わせる）
• GITHUB_XXX のグループ内の並び順が、コミットハッシュ⇒URLの順だと分かりやすい気配です。

これ書いてどうする？ってのは考えてませんでしたが、
出力をきれいに揃えてみて初めて見えてくる気付きもあるのかな？と思ってます。

#1190 に登録しました