| ローカルビルド | Appveyor | Azure Pipelines | gitbash.h への出力 | ||
|---|---|---|---|---|---|
| GIT_COMMIT_HASH | git の commit Hash | ◎ | ◎ | ◎ | ◎ |
| GIT_SHORT_COMMIT_HASH | git の commit Hash 短縮形 | ◎ | ◎ | ◎ | ◎ |
| GIT_REMOTE_ORIGIN_URL | git remote origin URL | ◎ | ◎ | ◎ | ◎ |
| GIT_TAG_NAME | git の tag | ◎ | ◎ | ◎ | ◎ |
| CI_ACCOUNT_NAME | CI のアカウント名 | × | ◎ | ◎ | ◎ |
| CI_BUILD_NUMBER | CI のビルド番号 (数値) | × | ◎ | ◎ | ◎ |
| CI_BUILD_URL | CI のビルドURL | × | ◎ | ◎ | ◎ |
| CI_BUILD_VERSION | CI のビルドバージョン (文字列) | × | ◎ | ◎ | ◎ |
| CI_REPO_NAME | リポジトリ名 | × | ◎ | ◎ | ◎ |
| GITHUB_COMMIT_URL | GitHub の Commit URL | × | ◎ | ◎ | ◎ |
| GITHUB_PR_HEAD_URL | GitHub の PR の Head の URL | × | ○ (PRのみ) | ○ (PRのみ) | ○ (PRのみ) |
| GITHUB_PR_HEAD_COMMIT | GitHub の PR の Head Revision | × | ○ (PRのみ) | ○ (PRのみ) | ○ (PRのみ) |
| GITHUB_PR_HEAD_SHORT_COMMIT | GitHub の PR の Head Revision 短縮形 | × | ○ (PRのみ) | ○ (PRのみ) | ○ (PRのみ) |
| GITHUB_PR_NUMBER | GitHub の PR 番号 | × | ○ (PRのみ) | ○ (PRのみ) | ○ (PRのみ) |
| DEV_VERSION | 開発バージョンかどうか | ◎ | ◎ | ◎ | ◎ |
| 環境変数 | 説明 |
|---|---|
| APPVEYOR | バッチが appveyor で実行されているかどうか |
| APPVEYOR_ACCOUNT_NAME | appveyor のアカウント名 (sakura editor の場合 "sakuraeditor") |
| APPVEYOR_BUILD_NUMBER | ビルド番号 |
| APPVEYOR_URL | https://ci.appveyor.com |
| APPVEYOR_BUILD_VERSION | appveyor.yml の version フィールドの値 |
| APPVEYOR_BUILD_ID | ビルドID (ビルド結果URLに含まれる数値です。build-chm.batが実行中のビルドを識別するために使います。) |
| APPVEYOR_PROJECT_SLUG | project slug (appveyor の URL 名) |
| APPVEYOR_PULL_REQUEST_NUMBER | Pull Request 番号 |
| APPVEYOR_PULL_REQUEST_HEAD_COMMIT | Pull Request の Head commit Hash |
| APPVEYOR_REPO_NAME | リポジトリ名 (owner-name/repo-name) |
| APPVEYOR_REPO_PROVIDER | appveyor の参照するリポジトリ種別 (GitHub の場合 "gitHub") |
| デバッグ用です。 appveyor の REST API に渡す Bearer Token をスクリプト外から渡せるように定義しています。 appveyor では使いません。(未定義なので値は''になります。) |
APPVEYOR_REPO_TAG_NAME は利用をやめて 代わりに GIT_TAG_NAME を使うようにしました。#876
- 上記環境変数をローカル環境で set コマンドで設定することにより appveyor でビルドしなくてもローカルでテストできます。
- 上記の環境変数がどんな値になるのかは、過去の appveyor ビルドでのログを見ることによって確認できます。
build-chm.batをローカルでテストするには完了済みのビルドIDが必要です。ビルドIDはhistoryから各ビルド結果を表示するとURL末尾に付いている数字です。
| 環境変数 | 説明 |
|---|---|
| BUILD_REPOSITORY_NAME | リポジトリ名 (owner-name/repo-name) |
| BUILD_DEFINITIONNAME | アカウント名 |
| BUILD_BUILDID | ビルド番号 (数値) |
| BUILD_BUILDNUMBER | ビルドバージョン (文字列) |
| SYSTEM_PULLREQUEST_PULLREQUESTNUMBER | Pull Request 番号 |
| SYSTEM_PULLREQUEST_SOURCECOMMITID | Pull Request の Head commit Hash |
| 生成するマクロ名 | 元にする環境変数 | 型 |
|---|---|---|
| GIT_SHORT_COMMIT_HASH | GIT_SHORT_COMMIT_HASH | 文字列 |
| GIT_COMMIT_HASH | GIT_COMMIT_HASH | 文字列 |
| GIT_REMOTE_ORIGIN_URL | GIT_REMOTE_ORIGIN_URL | 文字列 |
| GIT_TAG_NAME | GIT_TAG_NAME | 文字列 |
| CI_REPO_NAME | CI_REPO_NAME | 文字列 |
| DEV_VERSION | - | - |
| CI_ACCOUNT_NAME | CI_ACCOUNT_NAME | 文字列 |
| CI_BUILD_VERSION | CI_BUILD_VERSION | 文字列 |
| CI_BUILD_NUMBER | CI_BUILD_NUMBER | 文字列 |
| CI_BUILD_NUMBER_INT | CI_BUILD_NUMBER | 数値 |
| CI_BUILD_NUMBER_LABEL | CI_BUILD_NUMBER | 文字列 |
| GITHUB_PR_NUMBER | GITHUB_PR_NUMBER | 文字列 |
| GITHUB_PR_NUMBER_INT | GITHUB_PR_NUMBER | 数値 |
| GITHUB_PR_NUMBER_LABEL | GITHUB_PR_NUMBER | 文字列 |
| GITHUB_COMMIT_URL | GITHUB_COMMIT_URL | 文字列 |
| GITHUB_PR_HEAD_URL | GITHUB_PR_HEAD_URL | 文字列 |
| GITHUB_PR_HEAD_COMMIT | GITHUB_PR_HEAD_COMMIT | 文字列 |
| GITHUB_PR_HEAD_SHORT_COMMIT | GITHUB_PR_HEAD_SHORT_COMMIT | 文字列 |
| CI_BUILD_URL | CI_BUILD_URL | 文字列 |
| 生成する環境変数 | 説明 | 有効性 |
|---|---|---|
| ALPHA | alpha バージョンの場合 1 | x64 ビルドの場合 |
| BUILD_ACCOUNT | CI のビルドアカウント名 | sakura editor 用のアカウントの場合空 |
| TAG_NAME | "tag_" + tag 名 | tag が有効な場合 |
| BUILD_NUMBER | "build" + ビルド番号 | CI ビルド以外の場合 "buildLocal" |
| PR_NAME | "PR" + PR番号 | CI での PR のビルドのみ有効 |
| SHORTHASH | commit hash の先頭8文字 | 実体は GIT_SHORT_COMMIT_HASH |
| RELEASE_PHASE | "alpha" または 空 | x64 ビルドの場合のみ有効 |
| BASENAME | 成果物の zip ファイル名(拡張子含まない部分) | 常に有効 |
| WORKDIR | 作業用フォルダ | 常に有効 |
| WORKDIR_LOG | ログファイル用の作業用フォルダ | 常に有効 |
| WORKDIR_EXE | 実行ファイル(一般向け)用の作業用フォルダ | 常に有効 |
| WORKDIR_DEV | 開発者向け成果物用の作業用フォルダ | 常に有効 |
| WORKDIR_INST | インストーラ用の作業用フォルダ | 常に有効 |
| WORKDIR_ASM | アセンブラ出力用の作業用フォルダ | 常に有効 |
| OUTFILE | 成果物の zip ファイル名 | 常に有効 |
| OUTFILE_LOG | ログファイルの成果物の zip ファイル名 | 常に有効 |
| OUTFILE_EXE | 実行ファイル(一般向け)の成果物の zip ファイル名 | 常に有効 |
| OUTFILE_DEV | 開発者向け成果物の zip ファイル名 | 常に有効 |
| OUTFILE_INST | インストーラの成果物の zip ファイル名 | 常に有効 |
| OUTFILE_ASM | アセンブラ出力の成果物の zip ファイル名 | 常に有効 |
| HASHFILE | sha256 のハッシュ値のファイル名 | 常に有効 |