AppVeyorでGitHubのリリースにビルドしたファイルを追加する

AppVeyor はWindows環境を使えるCI/CDサービスです。 (今はLinux環境も使えますが。)

ちょっと使う機会があったので、 Windows用のアプリとかをGitHubでコード管理してそのビルドしたものをGitHubのリリース領域に追加する、ということについてのメモ。

AppVeyor
テストレポジトリ
プロジェクト作成
アクセストークンの登録
appveyor.yml
実際にやったもの
GitHub Actions
vim_ahk
まとめ

AppVeyor

AppVeyorは Windows環境を使えるCI/CDサービスで、 Windows環境を使えるものがあまりないのでWindows用としてはよく使われているサービスだと思います。

勿論GitHubとも連携でき、登録などはTravis CIなどと似た感じ。

とりあえずGitHubのアカウントで登録してGitHubと連携してレポジトリを読み込めばレポジトリ毎にAppVeyorに登録出来ます。

テストレポジトリ

今回作ったのはこれ。

rcmdnk/appveyor_example: appveyor release exaple

.appveyor.ymlというのはAppVeyor用の設定ファイルですが、それ以外はbat/build.batというファイルがあって、これが build/test.txtというファイルを作成するだけのものです。

このbuild.batをAppVeyorでコミットのたびに実行するようにします。また、タグが作られたときだけそのタグを元にリリースとして作成しそのリリースに作成されたtest.txtを添付する、というのが目的。

一応出来たtest.txtの中身をチェックするテストを tests/test.batとして入れています。

実際には何かアプリ的なxxx.exeとかを作ってそれをテストしてGithubに貼り付ける感じです。

プロジェクト作成

GitHub側のAppVeyor設定で Repository accessをAll repositoriesにしておけば AppVeyor側のNew Project ページですべてのレポジトリが見える様になります。

もしくは特定のレポジトリだけをAppVeyorから見える様にすることもできます。

ここで連携したいレポジトリを選択してAppVeyor側にプロジェクトを作っておきます。

プロジェクトページのSettingsから色々と設定することが出来ますが、今回必要なのはGitHubにファイルをアップロードするために必要なアクセストークンの登録だけです。

アクセストークンの登録

GitHub側でSettingsDeveloper settings Personal access tokensに行って New personal access token します。

必要最低限としてはrepoの中のrepo_deploymentだけですが、 commitとかもするとしたらrepo全体をチェックして作成します。

ここで取得したアクセストークンを AppVeyorに戻って使いたいプロジェクトの SettingsEnvironmentに行って Environment Variablesの欄でAdd variableします。

nameは適当にgithub_accessとかにしてvalueの欄に取得したトークンを入れます。

この際、該当の入力欄にフォーカスがあたっていると右側に鍵マークが出るので、それを押すことで環境変数を暗号化することが出来ます。

今回のトークンの様なものは暗号化しておきます。

暗号化した値はPull Requestとかからは使えない様になります。

Build configuration AppVeyor

のSecure variablesの欄をみると古いのか、ちょっと仕様が違っていて、今のSettingsでは暗号化すると appveyor.ymlの中でenvironmentとして設定しなくても直接登録時に指定した名前で使えます。 (そのためのnameの登録だと思うので多分ドキュメントが古い。)

これでAppVeyor側の設定が出来たのでレポジトリ側に設定ファイルを作成します。

appveyor.yml

設定ファイルはレポジトリトップにappveryor.ymlか.appveyor.ymlという名前で置きます。

もしくはAppVeyorの該当プロジェクトでSettingsGeneralにある Custom configuration .yml file nameで名前を指定して使います。

今回の内容はこんな感じ。

.appveyor.yml

version: 0.1.{build}

artifacts:
  - path: ./build/test.txt
    name: Test file

build_script:
  - cmd: ./bat/build.bat

test_script:
  - cmd: ./tests/test.bat

deploy:
  provider: GitHub
  release: $(APPVEYOR_REPO_TAG_NAME)
  description: ''
  auth_token: $(github_access)
  artifact: 'Test file'
  draft: false
  prerelease: false
  on:
    APPVEYOR_REPO_TAG: true

最初のversionはGitHubのタグとかとは直接関係なくAppVeyor側の管理ようです。これだとビルドが行われるたびに0.1.1、0.1.2、0.1.3とビルド番号がつくようになります。

artifactsはビルドしてアウトプットにしたいものを指定します。今回はtest.text。nameは指定しなくても良いですが、後でGitHubに送ったりする時にnameを正規表現で指定して送ることも出来るので複数ファイルをまとめて送る際には設定しておくと便利です。

build_scriptはビルド用コマンド。今回はbuild.batを実行するだけ。

これ以外にもbefore_build/after_buildなども設定できます。

appveyor.yml Reference AppVeyor

その後でテストをします。 test_scriptで test.batを実行していますが、これは単にtest.txtの中身がbuild.batで作ったものかどうか(単にtest fileという内容)チェックするだけ。

最後にdeploy。

provider: ファイルを送る先
- GitHub ReleasesにdeployしたいのでGitHubを指定。
- それ以外にもAWSやAzure、もしくは単にFTPサーバーなども指定できます。(Deployment AppVeyor)
- 以下の設定はdeploy先によって変わるものもあります。
release: リリース名
- ここではAPPVEYOR_REPO_TAG_NAMEというAppVeyorによって予め設定される値を使っています。
- AppVeyorの設定ファイルの中で変数を値として使う場合には$()で表現します。
- APPVEYOR_REPO_TAG_NAMEはビルドのトリガーがタグだった場合にそのタグ名が入ります。(Environment variables AppVeyor)
- タグでない場合にはundefinedになります。
- 今回はタグの場合だけリリースを作るのでタグの名前でリリースを作る様にしています。
description: リリースの説明
- 指定しないとエラーになりますが、''を指定するとタグを作る時に付けた説明がリリースの説明にも使われます。
auth_token: GitHubへのアクセストークン
- 上で登録したアクセストークンの名前を指定します。
artifact: deployするオブジェクト
- GitHub Releasesに送りたいファイルの指定。
- ,で分けて複数指定可能。また/.*file/みたいな感じで正規表現を使って複数をまとめて送ることも出来ます。
draft: リリースをドラフト状態にするかどうか
prelelease: リリースをプレリリース状態にするかどうか
on: deployを実行する条件
- APPVEYOR_REPO_TAGもAppVeyorによって設定される値でタグがトリガーだとtrueになります。
- 条件のところで使う場合には$()は使いません。