GitHubActionsでクロスプラットフォーム用に実行ファイルを生成してリリースする

背景

ソースコード

実装

コードとしては以下

前述のリポジトリのコードそのままだと、CHANGELOGを自動生成していたり、debファイルやrpmファイルを生成していたりと複雑なので、win/linux/mac向けのビルド部分だけに簡略化した

code:release.yml

name: release

on:

push:

tags:

- 'v*.*.*'

env:

APP_NAME: 'APPNAME'

NIM_VERSION: 'stable'

MAINTAINER: 'MAINTAINER'

jobs:

build-artifact:

runs-on: ${{ matrix.os }}

strategy:

matrix:

os:

- ubuntu-latest

- windows-latest

- macOS-latest

steps:

- uses: actions/checkout@v1

- uses: jiro4989/setup-nim-action@v1

with:

nim-version: ${{ env.NIM_VERSION }}

# nimble buildで実行ファイルを生成する。

# nimbleファイルの設定で、実行ファイルを bin ディレクトリ配下に作成するようにしている。

# 理由は、実行ファイルを複数作成する場合の、CIからのファイル指定を楽にするため

- run: nimble build -Y -d:release

- name: Create artifact

run: |

os="${{ runner.os }}"

echo "$assets"

# リリース物をかためるディレクトリを作成してcopy

# Windowsではzip、それ以外のOSではtar.gzファイルとして圧縮する

mkdir -p "dist/$assets"

cp -r bin LICENSE README.* "dist/$assets/"

(

cd dist

7z a "$assets.zip" "$assets"

else

tar czf "$assets.tar.gz" "$assets"

fi

ls -lah *.*

)

shell: bash

- uses: actions/upload-artifact@v2

with:

name: artifact-${{ matrix.os }}

path: |

dist/*.tar.gz

dist/*.zip

create-release:

runs-on: ubuntu-latest

needs:

- build-artifact

steps:

- uses: actions/checkout@v1

- name: Create Release

id: create-release

uses: actions/create-release@v1

env:

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

with:

tag_name: ${{ github.ref }}

release_name: ${{ github.ref }}

body: Release

draft: false

prerelease: false

- name: Write upload_url to file

run: echo '${{ steps.create-release.outputs.upload_url }}' > upload_url.txt

- uses: actions/upload-artifact@v2

with:

name: create-release

path: upload_url.txt

upload-release:

runs-on: ubuntu-latest

needs: create-release

strategy:

matrix:

include:

- os: ubuntu-latest

asset_name_suffix: linux.tar.gz

asset_content_type: application/gzip

- os: windows-latest

asset_name_suffix: windows.zip

asset_content_type: application/zip

- os: macOS-latest

asset_name_suffix: macos.tar.gz

asset_content_type: application/gzip

steps:

- uses: actions/download-artifact@v2

with:

name: artifact-${{ matrix.os }}

- uses: actions/download-artifact@v2

with:

name: create-release

- id: vars

run: |

echo "::set-output name=upload_url::$(cat upload_url.txt)"

- name: Upload Release Asset

id: upload-release-asset

uses: actions/upload-release-asset@v1

env:

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

with:

upload_url: ${{ steps.vars.outputs.upload_url }}

asset_path: ${{ env.APP_NAME }}_${{ matrix.asset_name_suffix }}

asset_name: ${{ env.APP_NAME }}_${{ matrix.asset_name_suffix }}

asset_content_type: ${{ matrix.asset_content_type }}

実装解説

作りとしては、３ジョブになっている

build-artifactジョブ

create-releaseジョブ

upload-releaseジョブ

buildジョブではWindows VM、Linux VM、MacOS VMが並列に起動する

ここでバイナリを生成する

生成したバイナリをartifactとして保存する

この時点ではreleaseは存在せず、アップロードできない

別のジョブに成果物を引き継ぎたいときはartifactとして保存し、別ジョブからartifactをダウンロードすることで利用する

create-releaseは上記３つのジョブがすべて正常終了したときに1つ起動する

ここでGitHub Releaseを生成する

GitHub ReleaseをActionで作成すると、色々とメタ情報が得られる

このアップロード用のURLは、upload-releaseのジョブで利用するのでartifactとして保存する

uploadジョブでは、Windows VM、Linux VM、MacOS VMが並列に起動する

buildジョブで保存したartifactをダウンロードする

releaseへのアップロード用のURLもartifactからダウンロードする

生成されたReleaseに対して、artifactをアップロードする

上記流れを図にしたものが以下

https://user-images.githubusercontent.com/13825004/87944618-9897fc00-cada-11ea-9401-74167f04b5c4.png

右側にdebとrpm用のワークフローが載ってるが無視して

リリース作業

tagを切ったらGitHubReleaseが作成されて、リリース物がアップロードされる

以下の手順でリリースワークフローが起動してリリースされる

code:sh

git tag v0.1.0

git push origin v0.1.0

# あるいは

git push origin --tags

まとめ

tagを切ってpushするだけでリリースが完了する

余談

まじでmacシェルにはイライラさせられる

BSD系のオプション違いだったりbash3だったり

code:sh

sed 's///g' file > file.tmp

mv file.tmp file

以上