アクションの自動リリース

GitHub の自動リリース

このアクションにより、アセットの自動アップロード、変更ログの生成、プレリリースの処理などが自動的に行われ、GitHub リリース プロセスが簡素化されます。

コンテンツ

1. 使用例
2. サポートされているパラメータ
3. イベントトリガー
4. バージョン管理
5. 助けを求める方法
6. ライセンス

注: marvinpinto/action-automatic-releasesリポジトリは、このアクションと他のアクションを含む marvinpinto/actions モノリポジトリの自動的に生成されたミラーです。そこに問題を提出し、プルリクエストを提出してください。

使用例

変更がマスターに到達したときにプレリリースを自動的に生成します

このサンプル ワークフローは、変更がmasterに到達するとすぐに開始されます。プロジェクトをビルドしてテストする手順を実行した後、次のようにします。

1. これにより、 latestという git タグが作成 (または置換) されます。
2. このタグと以前のlatestタグの間のすべてのコミットから変更ログを生成します。
3. latestタグに関連付けられた新しいリリースを生成します (以前の関連付けられたリリースは削除します)。
4. この新しいリリースを指定されたタイトルで更新します (例: Development Build )。
5. LICENSE.txtおよび任意のjarファイルをリリース アセットとしてアップロードします。
6. このリリースをpre-releaseとしてマークします。

このワークフローの実例は marvinpinto/actions でご覧いただけます。

---
name : " pre-release "

on :
  push :
    branches :
      - " master "

jobs :
  pre-release :
    name : " Pre Release "
    runs-on : " ubuntu-latest "

    steps :
      # ...
      - name : " Build & test "
        run : |
          echo "done!"

      - uses : " marvinpinto/action-automatic-releases@latest "
        with :
          repo_token : " ${{ secrets.GITHUB_TOKEN }} "
          automatic_release_tag : " latest "
          prerelease : true
          title : " Development Build "
          files : |
            LICENSE.txt
            *.jar

タグがリポジトリにプッシュされるときに新しい GitHub リリースを作成する

前の例と同様に、このワークフローは、新しいタグが GitHub にプッシュされるとすぐに開始されます。プロジェクトをビルドしてテストした後:

1. このタグと以前の semver のようなタグの間のすべてのコミットから変更ログを生成します。
2. 新しいリリースを生成し、このタグに関連付けます。
3. LICENSE.txtおよび任意のjarファイルをリリース アセットとしてアップロードします。

もう一度、この例が marvinpinto/actions にあります。

---
name : " tagged-release "

on :
  push :
    tags :
      - " v* "

jobs :
  tagged-release :
    name : " Tagged Release "
    runs-on : " ubuntu-latest "

    steps :
      # ...
      - name : " Build & test "
        run : |
          echo "done!"

      - uses : " marvinpinto/action-automatic-releases@latest "
        with :
          repo_token : " ${{ secrets.GITHUB_TOKEN }} "
          prerelease : false
          files : |
            LICENSE.txt
            *.jar 

サポートされているパラメータ

パラメータ	説明	デフォルト
repo_token **	GitHub アクション トークン (例: "${{ secrets.GITHUB_TOKEN }}" 。	null
draft	このリリースをドラフトとしてマークしますか?	false
prerelease	このリリースをプレリリースとしてマークしますか?	true
automatic_release_tag	自動リリースに使用するタグ名 (例: latest 。	null
title	リリースタイトル;何も指定されていない場合は、デフォルトでタグ名が使用されます。	タグ名
files	リリース アセットの一部としてアップロードするファイル。	null

出力

次の出力値には${{ steps..outputs. }}を介してアクセスできます。

名前	説明	タイプ
automatic_releases_tag	このアクションが処理したばかりのリリース タグ	弦
upload_url	追加のアセットをリリースにアップロードするための URL	弦

注:

• **で示されたパラメータは必須です。
• filesパラメータは複数行の glob パターンをサポートしています。リポジトリの例を参照してください。

イベントトリガー

GitHub Actions フレームワークを使用すると、イベントのさまざまな組み合わせでこの (およびその他の) アクションをトリガーできます。たとえば、リリース候補タグ (例: *-rc* ) の特定のプレリリースを作成したり、変更がマスターに到達したときにリリースを生成したり (上記の例)、夜間リリースなどを作成したりできます。アイデアや高度な例については、GitHub Actions のワークフロー構文を読んでください。

バージョン管理

このプロジェクトのマスターに到達するすべてのコミットは、自動ビルドと、 latestと呼ばれるタグ付きリリースをトリガーします。最前線での生活を望まない場合は、代わりに安定版リリースを使用することもできます。利用可能なバージョンについてはリリースを参照してください。

"">

- uses : " marvinpinto/action-automatic-releases@ " 

助けを求める方法

このプロジェクトのメイン README には、問題のデバッグと送信に関連する大量の情報が含まれています。それでも問題が解決しない場合は、キーベースで私に連絡してください。最善を尽くしてお手伝いします。

ライセンス

このプロジェクトのソース コードは MIT ライセンスに基づいてリリースされています。このプロジェクトは GitHub に関連付けられていません。