APPVEYOR_REPO_COMMIT の利用をやめる (APPVEYOR_SHORTHASH も廃止する) #886

m-tmatma · 2019-04-30T08:26:11Z

APPVEYOR_REPO_COMMIT の利用をやめる (APPVEYOR_SHORTHASH も廃止する)

背景

#821 で Azure Pipelines で環境変数の定義を検討中だが、
Azure Pipelinse の Predefined variables では
$(Build.SourceVersion) (YMLの場合) あるいは BUILD_SOURCEVERSION (バッチファイルの場合)
という appveyor と別の環境変数が割り当てられている。

しかも

git show -s --format=%H という git コマンドで取得できるので二重管理になっているので
APPVEYOR_REPO_COMMITを利用するのをやめる。
同様に APPVEYOR_SHORTHASH も対応する GIT_SHORT_COMMIT_HASHという変数があるので廃止する

2019/06/15 追記

TEMP_GIT_SHORT_COMMIT_HASH と TEMP_GIT_COMMIT_HASH を一時的に導入して
動作を維持するようにしました。

別の PR で GIT_SHORT_COMMIT_HASH と GIT_COMMIT_HASH に名前変更して仕様変更します。

仕様が変更になる点

ローカルビルドの場合は APPVEYOR_REPO_COMMIT が空だったので zip ファイル名には
commit hash が含まれなかったが、この PR 後は GIT_SHORT_COMMIT_HASH を
参照するようになるので Git が有効な場合には zip ファイル名に short hash が含まれるようになる。

m-tmatma · 2019-05-17T11:50:10Z

この頃は azure pipelines 通ってた。
https://dev.azure.com/sakuraeditor/sakura/_build/results?buildId=323

berryzplus · 2019-05-18T08:40:37Z

この頃は azure pipelines 通ってた。
https://dev.azure.com/sakuraeditor/sakura/_build/results?buildId=323

Pull-Requestビルドでも通ってるものがありますね。
https://dev.azure.com/sakuraeditor/sakura/_build/results?buildId=368

履歴を眺めるとPull-Request起因のビルドが軒並みコケてるように見えるので、conditionの条件指定になんらかの想定外要因があるのを疑っています。全部ダメなわけじゃないから違いはなんだ！なんですけどｗ

ちなみにこのPRについては、変更趣旨了解で問題なさそうと判断しています。マクロ定義の入替なので最低限grep確認とかする必要があると思ってて、作業できてないからレビューコメントしてない感じです。

m-tmatma · 2019-05-18T10:46:44Z

/azp run

azure-pipelines · 2019-05-18T10:47:24Z

Azure Pipelines successfully started running 1 pipeline(s).

m-tmatma · 2019-05-18T10:47:33Z

https://docs.microsoft.com/en-us/azure/devops/pipelines/repos/github?view=azure-devops&tabs=yaml#comment-triggers で /azp という省略形が使える。

m-tmatma · 2019-05-18T10:54:15Z

またビルドに失敗している。

m-tmatma · 2019-05-18T10:57:09Z

/azp run

azure-pipelines · 2019-05-18T10:57:49Z

Azure Pipelines successfully started running 1 pipeline(s).

berryzplus · 2019-05-18T13:52:32Z

/azp run

azure-pipelines · 2019-05-18T13:53:15Z

Azure Pipelines successfully started running 1 pipeline(s).

m-tmatma · 2019-05-26T06:54:03Z

rebase しました。レビューお願いします。

berryzplus · 2019-05-28T15:05:23Z

2256b58 commit に対する有効化条件の誤りを修正

このコミットの意図がよく分らんです。
(コミットメッセージにある「誤り」というのもよく分らんです。)

CAboutDlg に表示する情報の仕様変更にあたると思うんですけど、
なんで変えないといけないんでしたっけ？

たぶん、何か問題がある⇒変えよう、なはずで、
何を問題と考えたか、どう対策しようとしてるのかが共有できてないと思います。

m-tmatma · 2019-05-28T20:48:31Z

ローカルビルドでは、ハッシュが定義されますが
GitHub の URL は定義されません。

これまでのように、ハッシュだけで判断すると GitHub のURL のみ
定義されていないので、URL は表示されず、説明のテキストだけ
表示されて微妙な表示になります。

berryzplus · 2019-05-29T15:05:07Z

なんか問題があるように思えてきました。

ローカルビルドでは、ハッシュが定義されますが
GitHub の URL は定義されません。

これまでのように、ハッシュだけで判断すると GitHub のURL のみ
定義されていないので、URL は表示されず、説明のテキストだけ
表示されて微妙な表示になります。

この説明だけ読むと、これまで通りハッシュだけで判断できるように、GitHub の URLがないときはハッシュを定義しない をバッチ側に組み込めばよい気がします。

つまり、「sakura_rc.rcへの変更は本質的には必要ない」と読めます。。。

m-tmatma · 2019-05-30T14:04:02Z

表書いてみたけどあまりわかりやすくない。
でもせっかく書いたので残しておきます。

この PR 前

	ローカルビルド (git なし)	ローカルビルド (git あり)	Appveyor ビルド
GIT_COMMIT_HASH	×	〇	〇
GIT_SHORT_COMMIT_HASH (GIT_COMMIT_HASH に依存)	×	〇	〇
APPVEYOR_REPO_COMMIT	× (この変数を使用)	× (この変数を使用)	〇
APPVEYOR_SHORTHASH (APPVEYOR_REPO_COMMIT に依存)	×	×	〇
APPVEYOR_PULL_REQUEST_HEAD_COMMIT	×	×	〇
GITHUB_COMMIT_URL (APPVEYOR_REPO_COMMIT に依存)	×	×	〇
GITHUB_COMMIT_URL_PR_HEAD	×	×	〇 (APPVEYOR_PULL_REQUEST_HEAD_COMMIT で定義)

この PR 後

	ローカルビルド (git なし)	ローカルビルド (git あり)	Appveyor ビルド
GIT_COMMIT_HASH	× (この変数を使用)	〇 (この変数を使用)	〇
GIT_SHORT_COMMIT_HASH (GIT_COMMIT_HASH に依存)	×	〇	〇
APPVEYOR_REPO_COMMIT (appveyor 定義変数)	×	×	×
APPVEYOR_SHORTHASH (APPVEYOR_REPO_COMMITに依存)	×	×	×
APPVEYOR_PULL_REQUEST_HEAD_COMMIT	×	×	〇
GITHUB_COMMIT_URL (GIT_COMMIT_HASH に依存)	×	×	〇
GITHUB_COMMIT_URL_PR_HEAD	×	×	〇 (APPVEYOR_PULL_REQUEST_HEAD_COMMIT で定義)

m-tmatma · 2019-05-30T14:17:07Z

この PR の目的は、
appveyor 固有変数である APPVEYOR_REPO_COMMIT を使っていたのをやめて
sakura editor で定義した GIT_COMMIT_HASH を使うことです。

APPVEYOR_REPO_COMMIT は appveyor 環境でしか定義されないものです。
でも APPVEYOR_REPO_COMMIT は GIT_COMMIT_HASH と等しい値です。
なので利用するのをやめます。

ローカルビルドのとき、あるいは Azure Pipelines ビルドのときは GIT_COMMIT_HASH が
利用できますが、APPVEYOR_REPO_COMMIT は appveyor でしか利用できません。

APPVEYOR_PULL_REQUEST_HEAD_COMMIT に関しては、Git から情報が取れないので (取り方を知らないので) そのまま使います。

一方、 GITHUB_COMMIT_URL というのは appveyor の変数 (APPVEYOR_REPO_NAME) に依存しているので現状 appveyor ビルドのときのみ有効になる変数です。定義値が appveyor に依存はしていますが、
Azure Pipelines にある同様の変数から定義内容を変えることは可能です。

GITHUB_COMMIT_URL の変数が使えないからと言って、別に GIT_COMMIT_HASH (ソースツリーのコミットハッシュ) の値が無効になるわけではありません。
ローカルで Git 環境でビルドするときには利用できるからです。

それではなぜ APPVEYOR_SHORTHASH の部分を変えるかというと、この PR のもともとの動機である Azure Pipelines に対応準備のため、appveyor の変数に直接依存する部分をなくして、sakura editor で定義した変数に依存するようにして、appveyor の変数に対する参照を隠ぺいして局所化するためです。

berryzplus · 2019-05-31T03:20:25Z

現状のバージョン表示の仕様に、潜在的な「?」要素が潜んでいたことは分かりました。

とりあえず一旦これで行くか、環境変数の仕様(=何を意味する変数か？)を整理して各変数を個別に再定義して行くか、どちらが良いかを迷っています。

個人的には後者がいいと思っていますが、結構めんどくさそうなのがネック。

バージョン情報として表示する情報である以上、「各変数が何を意味するものか分からん」ということはないと思っています。何を意味する情報かがわかるなら、元ネタとして最低限必要な情報を特定できます。派生情報に当たる部分は環境に依存しない方法で共通化出来ます。

さて、どうしたものか。

m-tmatma · 2019-05-31T03:40:49Z

全体の整理は #821 で行います。
その前に要らないものが、あれば削除していきます

m-tmatma · 2019-05-31T13:40:19Z

一方、 GITHUB_COMMIT_URL というのは appveyor の変数 (APPVEYOR_REPO_NAME) に依存しているので現状 appveyor ビルドのときのみ有効になる変数です。

git config --get remote.origin.url
を使えば remote URL をとれるので、頑張ればローカルビルドでも取れると思います。
ただ git プロトコルの場合の考慮とか、末尾の .git をとる対応とかしないといけないので
めんどくさいです。

berryzplus · 2019-06-01T08:46:09Z

ただ git プロトコルの場合の考慮とか、末尾の .git をとる対応とかしないといけないので
めんどくさいです。

gitプロトコルを考慮すべきかどうかは要件次第だと思います。
リンク先は Internet Explorer で開ける Webサイトでなければならない
という要件を決めたのは誰でしょう？
「そんな要件はない！」がぼくの見解です 😄

m-tmatma · 2019-06-01T08:49:14Z

GITHUB_COMMIT_URL の名前からして、GitHub の対応するコミットに対応する URL という前提です。
remote URL ではないです。remote URL という項目だったら git プロトコルでも http でもありなんですが。

m-tmatma · 2019-07-21T01:45:28Z

リンクとしては作動しないけどテキストとしては表示される

だいぶん前のことなのでちょっと問題の内容を書き間違えた。

これ自体に問題はないように思います。
このコントロールは本来 LTEXT(＝ただのラベル) だからです。
ラベルだから、仮にリンクさせる対象がなくても表示していいと思います。

https://github.com/sakura-editor/sakura/pull/886/files#diff-67955f03bb0bbb169f93ff6fa4998095

もともとは APPVEYOR_SHORTHASH を参照してラベルを表示するかしないかの条件コンパイルです。
でもこの PR では APPVEYOR_SHORTHASH を廃止して、GIT_SHORT_COMMIT_HASH に置き換えます。

そうすると、appveyor では APPVEYOR_SHORTHASH は定義されていますが、
Azure Pipelines では APPVEYOR_SHORTHASH は定義されていません。

この PR で APPVEYOR_SHORTHASH → GIT_SHORT_COMMIT_HASH に変えた場合
appveyor では動作が変わらないですが、

Azure Pipelines では GIT_SHORT_COMMIT_HASHが定義されているので、
IDC_STATIC_URL_GITHUB_CAPTION が定義されますが、
IDC_STATIC_URL_GITHUB_COMMIT が定義されないということになります。

単純に APPVEYOR_SHORTHASH → GIT_SHORT_COMMIT_HASH にすると
azure pipelines では IDC_STATIC_URL_GITHUB_CAPTION は表示されるが
IDC_STATIC_URL_GITHUB_COMMIT は表示されないという
これまでの動きと異なることになります。

git checkout master -- sakura_core/sakura_rc.rc git checkout master -- sakura_lang_en_US/sakura_lang_rc.rc

AppVeyorBot · 2019-07-21T02:06:05Z

✅ Build sakura 1.0.2063 completed (commit cbf1348762 by @m-tmatma)

git checkout master -- sakura_core/dlg/CDlgAbout.cpp

m-tmatma · 2019-07-21T02:20:20Z

ぐちゃぐちゃになったので、動作確認後、PR 作り直します。

方針は

TEMP_GIT_SHORT_COMMIT_HASH と TEMP_GIT_COMMIT_HASH を一時的に導入する
TEMP_GIT_SHORT_COMMIT_HASH と TEMP_GIT_COMMIT_HASH は githash.bat で定義する
APPVEYOR_SHORTHASH → TEMP_GIT_SHORT_COMMIT_HASH への一括置換
APPVEYOR_REPO_COMMIT → TEMP_GIT_COMMIT_HASH への一括置換
環境変数 APPVEYOR が定義されているときに TEMP_GIT_SHORT_COMMIT_HASH は GIT_SHORT_COMMIT_HASH (GIT_COMMIT_HASH) をもとに定義する
環境変数 APPVEYOR が定義されているときに TEMP_GIT_COMMIT_HASH は GIT_COMMIT_HASH をもとに定義する

AppVeyorBot · 2019-07-21T02:34:23Z

✅ Build sakura 1.0.2064 completed (commit 3e6a569248 by @m-tmatma)

AppVeyorBot · 2019-07-21T03:02:35Z

✅ Build sakura 1.0.2066 completed (commit 26d8239661 by @m-tmatma)

m-tmatma · 2019-07-21T04:13:33Z

#969 を作成したので、クローズ

berryzplus · 2019-07-21T04:19:24Z

なんかすんません。

このあたりのレスをみて「なんで？」と思いました。

この PR で APPVEYOR_SHORTHASH → GIT_SHORT_COMMIT_HASH に変えた場合
appveyor では動作が変わらないですが、
Azure Pipelines では GIT_SHORT_COMMIT_HASHが定義されているので、
(中略) が定義されないということになります。

「appveyor では動作が変わらないですがazure pipelinesでは動作が変わる」と言ってるように見えました。それってつまり、本来の目的を達成しとらんような気がするんです。（まぁ、そういうわけじゃないんだと思いますが。

目的：
APPVEYOR_SHORTHASH (appveyor専用、azure pipelinesには無い)
　↓
GIT_SHORT_COMMIT_HASH (azure pipelinesにもある同等の値を使う)

m-tmatma · 2019-07-21T04:23:35Z

azure pipelines やローカルビルドの振る舞いを変えないための経過措置です
リファクタリングだけに絞ったからです。

別の PR で azure pipelines 対応します

m-tmatma · 2019-07-21T04:25:24Z

↑ #969 の話

m-tmatma added the specification change ■仕様変更 label Apr 30, 2019

m-tmatma added this to the v2.4.0 milestone Apr 30, 2019

m-tmatma mentioned this pull request May 18, 2019

Azure Pipelines の導入 sakura-editor/management-forum#65

Closed

m-tmatma force-pushed the feature/suspension-use-APPVEYOR_REPO_COMMIT branch 2 times, most recently from 486187c to 40027f5 Compare May 22, 2019 13:07

m-tmatma force-pushed the feature/suspension-use-APPVEYOR_REPO_COMMIT branch from 40027f5 to 872801b Compare May 26, 2019 06:53

m-tmatma added appveyor azure pipelines CI appveyor など CI 関連【ChangeLog除外】 labels May 26, 2019

m-tmatma added 10 commits July 21, 2019 10:36

GitHash 関連の環境変数が定義されるように githash.bat を呼び出す

d035806

APPVEYOR_REPO_COMMIT => GIT_COMMIT_HASH

7aa9cd3

APPVEYOR_SHORTHASH => GIT_SHORT_COMMIT_HASH

27dc085

APPVEYOR_SHORTHASH を削除

5249caa

APPVEYOR_SHORTHASH を削除

54d0a7f

ドキュメントから APPVEYOR_SHORTHASH を削除

886a1a4

APPVEYOR_REPO_COMMIT の説明を削除

7f84c3e

commit に対する有効化条件の誤りを修正

4d3c5e4

GitHub の URL の有効化条件を修正

f00b772

zip ファイルに githash をつけない

be371a7

m-tmatma force-pushed the feature/suspension-use-APPVEYOR_REPO_COMMIT branch from 3cbcfbb to be371a7 Compare July 21, 2019 01:36

m-tmatma added 3 commits July 21, 2019 11:01

TEMP_GIT_SHORT_COMMIT_HASH, TEMP_GIT_COMMIT_HASH を導入

78d886f

いったん master の状態に戻す

95f541c

git checkout master -- sakura_core/sakura_rc.rc git checkout master -- sakura_lang_en_US/sakura_lang_rc.rc

TEMP_GIT_SHORT_COMMIT_HASH に差し替え

4a0c89a

m-tmatma added 3 commits July 21, 2019 11:09

TEMP_GIT_SHORT_COMMIT_HASH に差し替え

4c080a4

いったん master に戻す

fdc53b7

git checkout master -- sakura_core/dlg/CDlgAbout.cpp

TEMP_GIT_SHORT_COMMIT_HASH

dd283ba

m-tmatma mentioned this pull request Jul 21, 2019

APPVEYOR_REPO_COMMIT および APPVEYOR_SHORTHASH への参照を廃止、代替変数を参照して Azure Pipelines 対応の準備をする #969

Merged

m-tmatma closed this Jul 21, 2019

m-tmatma mentioned this pull request Feb 11, 2020

TEMP_GIT_SHORT_COMMIT_HASH および TEMP_GIT_COMMIT_HASH を廃止する #1193

Merged

m-tmatma deleted the feature/suspension-use-APPVEYOR_REPO_COMMIT branch February 11, 2020 00:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

APPVEYOR_REPO_COMMIT の利用をやめる (APPVEYOR_SHORTHASH も廃止する) #886

APPVEYOR_REPO_COMMIT の利用をやめる (APPVEYOR_SHORTHASH も廃止する) #886

m-tmatma commented Apr 30, 2019 •

edited

Loading

m-tmatma commented May 17, 2019

berryzplus commented May 18, 2019

m-tmatma commented May 18, 2019

azure-pipelines bot commented May 18, 2019

m-tmatma commented May 18, 2019

m-tmatma commented May 18, 2019

m-tmatma commented May 18, 2019

azure-pipelines bot commented May 18, 2019

berryzplus commented May 18, 2019

azure-pipelines bot commented May 18, 2019

m-tmatma commented May 26, 2019

berryzplus commented May 28, 2019

m-tmatma commented May 28, 2019

berryzplus commented May 29, 2019

m-tmatma commented May 30, 2019 •

edited

Loading

m-tmatma commented May 30, 2019 •

edited

Loading

berryzplus commented May 31, 2019

m-tmatma commented May 31, 2019

m-tmatma commented May 31, 2019

berryzplus commented Jun 1, 2019

m-tmatma commented Jun 1, 2019

m-tmatma commented Jul 21, 2019

AppVeyorBot commented Jul 21, 2019

m-tmatma commented Jul 21, 2019

AppVeyorBot commented Jul 21, 2019

AppVeyorBot commented Jul 21, 2019

m-tmatma commented Jul 21, 2019

berryzplus commented Jul 21, 2019

m-tmatma commented Jul 21, 2019

m-tmatma commented Jul 21, 2019

APPVEYOR_REPO_COMMIT の利用をやめる (APPVEYOR_SHORTHASH も廃止する) #886

APPVEYOR_REPO_COMMIT の利用をやめる (APPVEYOR_SHORTHASH も廃止する) #886

Conversation

m-tmatma commented Apr 30, 2019 • edited Loading

背景

2019/06/15 追記

仕様が変更になる点

m-tmatma commented May 17, 2019

berryzplus commented May 18, 2019

m-tmatma commented May 18, 2019

azure-pipelines bot commented May 18, 2019

m-tmatma commented May 18, 2019

m-tmatma commented May 18, 2019

m-tmatma commented May 18, 2019

azure-pipelines bot commented May 18, 2019

berryzplus commented May 18, 2019

azure-pipelines bot commented May 18, 2019

m-tmatma commented May 26, 2019

berryzplus commented May 28, 2019

m-tmatma commented May 28, 2019

berryzplus commented May 29, 2019

m-tmatma commented May 30, 2019 • edited Loading

この PR 前

この PR 後

m-tmatma commented May 30, 2019 • edited Loading

berryzplus commented May 31, 2019

m-tmatma commented May 31, 2019

m-tmatma commented May 31, 2019

berryzplus commented Jun 1, 2019

m-tmatma commented Jun 1, 2019

m-tmatma commented Jul 21, 2019

AppVeyorBot commented Jul 21, 2019

m-tmatma commented Jul 21, 2019

AppVeyorBot commented Jul 21, 2019

AppVeyorBot commented Jul 21, 2019

m-tmatma commented Jul 21, 2019

berryzplus commented Jul 21, 2019

m-tmatma commented Jul 21, 2019

m-tmatma commented Jul 21, 2019

m-tmatma commented Apr 30, 2019 •

edited

Loading

m-tmatma commented May 30, 2019 •

edited

Loading

m-tmatma commented May 30, 2019 •

edited

Loading