Publish packages via GitHub Actions

[sallyluenoa]

概要

• ライブラリをGitHub Actions 経由でパッケージ公開する

実装方針

参考資料 or 関連issues

• https://docs.github.com/ja/actions/guides/publishing-java-packages-with-gradle
• https://docs.github.com/ja/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry

[sallyluenoa]

最新の注釈付きタグを取得するコマンド

$ git describe --abbrev=0

ただしタグを打った時点では、前のタグを返してしまうバグがある模様。（現時点では Not Fixed.）
actions/checkout#272

[sallyluenoa]

タグ名を取得する方法
GITHUB_REF（ワークフローをトリガーしたブランチまたはタグref）でタグ打った時のアクションで使える。
https://github.community/t/how-to-get-just-the-tag-name/16241

[sallyluenoa]

テスト用に v0.1.0 タグを打った
https://github.com/sallyluenoa/FRExtensions/releases/tag/v0.1.0

[sallyluenoa]

master branch -> git describe --tag
tag (release) -> GITHUB_REF

で、バージョン取得できそう

[sallyluenoa]

ビルド番号に悩み中...
GITHUB_RUN_NUMBER はワークフローごとにナンバリングされるため、「master起因のビルド番号＞その後でタグリリースした成果物のビルド番号」という逆転事象が起きてしまう。
プロジェクトを通して、ビルド番号をインクリメント（せめてmasterブランチのものとリリース成果物イコールまで）の状態にしたい。

einaregilsson/build-number@v3 が使えるかも？と試したが、タグを打つことでビルド番号を生成している模様。
リリース時にタグ打ちすることでCIトリガーにしたいので、ちょっと用途に合わない

[sallyluenoa]

これまでに打ったタグでわかるかなと思ったけど、タグ打った時点ではそのタグは無視される不具合があるらしいので微妙かも。
masterブランチトリガーなので、マージコミットをカウントすることでビルド番号にするのはよいかも？

$ git rev-list --merges --count HEAD
10

[sallyluenoa]

何度かお試しで作っていることで、Package公開する方法を把握した
https://github.com/sallyluenoa/FRExtensions/packages/913012

ついでに Pages のやり方も別途把握、mdファイルをよしなにhtmlに変換してくれる。
KDocはここに公開でよさそう
https://sallyluenoa.github.io/FRExtensions/

[sallyluenoa]

EndBug/add-and-commit@v7 で自動コミット追加できることを把握。
docsの自動アップデートが実現可能そう。
838f83c

ReleaseをトリガーにデプロイCI回すと、↑のコミットでRelease Tagが最新コミットじゃなくなくなってしまう。
Release トリガーじゃなくて一番最後に Release したいかな。

[sallyluenoa]

GitHub Actions からの Release

https://github.com/actions/create-release
https://github.com/actions/upload-release-asset

[sallyluenoa]

リリースデプロイの大まかな流れ

前提

• master: リリース用ブランチ、root を Pages 指定
• develop: 開発用ブランチ

トリガー方法

1. develop にて _version.yml のバージョンを書き換える
2. develop を master にマージ

GitHub Actions の流れ

1. 成果物（.aar, apk）生成 + Package公開
   • gradlew assembleRelease publish
2. ドキュメント（KDoc）生成
   • gradlew dokkaHtml
3. ドキュメント配置＋コミット
   • cp [dokkaPath] ./docs
   • EndBug/add-and-commit
4. リリース作成
   • create/release
5. Assetアップロード
   • upload-release-asset
   • .aar, .apk, ./docs(zip)

[sallyluenoa]

CI 自動デプロイOK。DOCアップデート、リリースも一通りできている。
https://github.com/sallyluenoa/FRExtensions/actions/runs/1086674597

ただし１点残念なのが、タグのターゲットがマージコミットハッシュのままであること。
DOCアップデートのコミットハッシュ（master最新）が理想。

[sallyluenoa]

タグの付与先を master に指定することで、想定どおりのデプロイが完成した。
条件を満たしたためcloseする。