Skip to content

A GitHub Action to upload an asset file and changelog to a GitHub release

License

Notifications You must be signed in to change notification settings

yakuhzi/github-release

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

GitHub Release Action

A GitHub Action that creates a GitHub release with automatically generated release notes from semantic commit messages. Also, a file can be uploaded and attached to the newly created GitHub release and send over Telegram.

Usage

Here is an example how to use this action:

- name: Create GitHub release
  uses: yakuhzi/github-release@v4
  with:
    file: /path/to/file.ext
    asset_name: file.ext
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Make sure to fetch the whole repository history, otherwise release notes can't be generated properly:

- name: Checkout
  uses: actions/checkout@main
  with:
    fetch-depth: 0

To also send the asset file over Telegram, add the following environment variables:

bot-token: /path/to/file.ext
chat-id: 123456

If you also want to send the released app name and version in a Firebase message, add the following environment variables (where FIREBASE_SERVICE_ACCOUNT_KEY is the base64 encoded service account key JSON):

firebase-service-account-key: ${{ secrets.FIREBASE_SERVICE_ACCOUNT_KEY }}
firebase-topic: ${{ secrets.FIREBASE_TOPIC }}
app-name: ${{ secrets.APP_NAME }}

About

A GitHub Action to upload an asset file and changelog to a GitHub release

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published