GitHub Action - Releases API

This GitHub Action uploads release assets using Upload a release asset.

FEATURE

• You can upload multiple assets in one step by using glob patterns
• The actions guesses the content-type from the extensions

SYNOPSIS

Upload assets when a release has been created

You can upload assets when a release has been created.

on:
  release:
    types:
      - created

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      # steps for building assets
      - run: echo "REPLACE ME!" > assets.txt

      - uses: shogo82148/actions-upload-release-asset@v1
        with:
          upload_url: ${{ github.event.release.upload_url }}
          asset_path: assets.txt

Upload assets when a tag has been created

If you want to create a release in your workflow, you can use shogo82148/actions-create-release GitHub Action.

on:
  push:
    tags:
      - 'v*'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      # steps for building assets
      - run: echo "REPLACE ME!" > assets.txt

      - name: Create Release
        id: create_release
        uses: shogo82148/actions-create-release@v1

      - uses: shogo82148/actions-upload-release-asset@v1
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: assets.txt

Inputs

github_token

The API token for GitHub. ${{ github.token }} is used by default.

upload_url

The URL for uploading assets to the release.

asset_path

The path to the asset you want to upload. You can use glob patterns here.

asset_name

The name of the asset you want to upload. The file name of asset_path is used by default.

asset_content_type

The content-type of the asset you want to upload. See the supported Media Types here: https://www.iana.org/assignments/media-types/media-types.xhtml for more information.

By default, the actions guesses the content-type using the mime-types package.

overwrite

If an asset with the same name already exists, overwrite it (Default: false).

Related works

• actions/upload-release-asset GitHub Action