🍈
GitHub Releases を使ってリリースページを作る
簡単ながら自作CLIツールを作ったので、ついでにGitHub Releases を使ってリリースページを作ってみました。本記事は公開までの備忘録になります。
公開したリリースページ
GitHub Releases とは
GitHubより引用します。
他の人が使用できるようにソフトウェア、リリースノート、バイナリファイルへのリンクをパッケージしたリリースを作成できます。
プロジェクトの特定のバージョン（例: v1.0.0）をまとめて配布・告知する仕組みで、ソフトウェアをユーザーや開発者に届ける公式リリースとしても機能します。
本機能を利用するメリットは以下の通りです。
- ビルド済みバイナリを添付できユーザーがすぐ試せる
- タグ付けでバージョン管理が明確になる
- 通知や連携で公開を広く知らせられる
公開まで①: タグつけする
最初にプロジェクトにタグを付与します。
git tag -a [タグ名] -m [メッセージ]
デフォルトの git push コマンドはリモートリポジトリにタグ情報を送信しません。次のコマンドでタグ情報を送信します。
git push origin [tagname]
公開まで②: バイナリを作成する
ツール作成にあたり実行環境の Deno には実行可能ファイルのコンパイル機能が提供されています。
次のコマンドはパーミッションフラグ、実行可能ファイル名、プラットフォームのバイナリを指定しています。
deno compile --target x86_64-pc-windows-msvc --allow-read --allow-write --output tasklog main.ts
--target オプションとOSの対応は以下の表にまとめました。
| OS | ターゲット(--target) |
|---|---|
| macOS |
x86_64-apple-darwin, aarch64-apple-darwin
|
| Linux |
x86_64-unknown-linux-gnu, aarch64-unknown-linux-gnu
|
| Windows | x86_64-pc-windows-msvc |
公開まで③: タイトル・リリースノートを書く
必要な内容を記載します。今回は ver 1.0.0なので、バグ改修はなく、新機能や使い方を中心に書きました。
作成バイナリも忘れずに添付します。
感想
公開までの作業は簡単でした。
今回はすべての作業を手作業で行いましたが、GitHub Actions を使ってタグ付けをトリガーにビルド、リリース自動化できるようです。次回以降の課題です。
Discussion