Skip to content
tag

GitHub Action

GitHub Releases

v1.3 Latest version

GitHub Releases

tag

GitHub Releases

Upload build artifacts to GitHub releases

Installation

Copy and paste the following snippet into your .yml file.

              

- name: GitHub Releases

uses: fnkr/[email protected]

Learn more about this action in fnkr/github-action-ghr

Choose a version

GitHub Action to upload build artifacts to GitHub releases using ghr. The action will trigger on pushes to tags and exit neutrally otherwise.

Secrets

  • GITHUB_TOKENRequired. Grants access to the repository.

Variables

  • GHR_PATHRequired. Path to the artifacts you want to upload. You can specify a file or a directory. If you provide a directory, all files in that directory will be uploaded.

  • GHR_COMPRESSOptional. Compress files before uploading them. Can be either gz, bz2, xz, or zip. The correct file extension will be appended (e.g. .tar.gz, or .zip).

  • GHR_DELETEOptional. Delete release and its git tag in advance if it exists. Can be either true or false

  • GHR_REPLACEOptional. Replace artifacts if it is already uploaded. Can be either true or false

  • GHR_PARALLELISMOptional. Set amount of parallelism

Usage example

YAML

on: push
name: Build and release on push
jobs:
  release:
    name: Release
    runs-on: ubuntu-latest
    steps:
      - name: Release
        uses: fnkr/github-action-ghr@v1
        if: startsWith(github.ref, 'refs/tags/')
        env:
          GHR_COMPRESS: xz
          GHR_PATH: build/
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}