Repolode
softprops

softprops/action-gh-release

Linux、Windows、macOSのrunnerからGitHub Releaseを作成し、ビルド成果物をアップロードするGitHub Action。

スター
5,794
フォーク
646
未解決の Issue
123
最終コミット
一昨日

これは何?

action-gh-releaseは、タグに対するGitHub Releaseを作成し、ビルド成果物をアップロードするGitHub Actionです。通常はビルド後に実行するworkflowのstepとして追加し、パイプラインで生成したバイナリ、アーカイブ、チェックサムなどを自動的にリリースに添付します。

files inputでは改行区切りのglobパターンを指定でき、body_pathでファイルからリリースノートを読み込むか、GitHubの組み込みの自動生成ノートを利用できます。draftとprereleaseのフラグ、同じタグの既存リリースの再利用、既存の本文への追記、リンクされたdiscussionの作成、自動生成ノートの比較ベースの固定にも対応しています。出力にはリリースURL、ID、アップロードURL、アップロードしたアセットのJSONリストが含まれます。

Linux、Windows、macOSのrunnerで実行できます。v3リリースはNode 24を対象としており、workflow tokenにcontents: write権限が必要です。

主な機能

  • 01タグに対するGitHub Releaseを作成するか、そのタグの既存リリースを更新します。
  • 02globパターンに一致するファイルをアップロードでき、任意で作業ディレクトリも指定できます。
  • 03ファイルからリリースノートを読み込むか、GitHubの自動生成リリースノートを利用できます。
  • 04draft、prerelease、make_latestの設定に対応しています。
  • 05Linux、Windows、macOSのrunnerで実行できます。
  • 06リリースURL、ID、アップロードURL、アップロードしたアセットの詳細を出力します。

ユースケース

  • バージョンタグがpushされたとき、CIビルドでコンパイルしたバイナリをGitHub Releaseに公開する。
  • 各リリースにチェックサムやパッケージ化したアーカイブを自動的に添付する。
  • タグ付きビルドの実行時に、changelogファイルまたはGitHubの自動生成ノートからリリースノートを作成する。

クイックスタート

  1. 1

    ワークフローファイルにリリースのステップを追加します

    uses: softprops/action-gh-release@v3
  2. 2

    タグのプッシュ時にのみリリースのステップを実行し、files にアセットを列挙します

使う前に知っておきたいこと

  • GitHub Actions のワークフロー内でのみ実行でき、単独のツールとしては使用できません。
  • 他のリポジトリのリリースを作成するには、適切な権限を持つ個人用アクセストークンが必要です。

収録されている特集

トピック

よくある質問

action-gh-release とは?
Linux、Windows、macOSのrunnerからGitHub Releaseを作成し、ビルド成果物をアップロードするGitHub Action。 action-gh-releaseは、タグに対するGitHub Releaseを作成し、ビルド成果物をアップロードするGitHub Actionです。通常はビルド後に実行するworkflowのstepとして追加し、パイプラインで生成したバイナリ、アーカイブ、チェックサムなどを自動的にリリースに添付します。
action-gh-release は無料で使えますか?ライセンスは?
action-gh-release は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
action-gh-release は今もメンテナンスされていますか?
活発にメンテナンス中。action-gh-release の最終コミットは 2026年11月5日 です。
action-gh-release は何に使えますか?
バージョンタグがpushされたとき、CIビルドでコンパイルしたバイナリをGitHub Releaseに公開する。 各リリースにチェックサムやパッケージ化したアーカイブを自動的に添付する。 タグ付きビルドの実行時に、changelogファイルまたはGitHubの自動生成ノートからリリースノートを作成する。
action-gh-release のインストール方法は?
ワークフローファイルにリリースのステップを追加します: uses: softprops/action-gh-release@v3 タグのプッシュ時にのみリリースのステップを実行し、files にアセットを列挙します
action-gh-release はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/softprops/action-gh-release

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト