Pipe to Release

We made this repository because we had some trouble with other existing repos like upload-release-action that were just no longer maintained and couldn't upload multiple files.

Options

Heres a list of all the options you can include into the with block.

name	description	required	default
token	The token this action uses to contact the github api.	true	none
repository	The repository where the release will be created in.	false	active repository
filemap	The list of files that will be uploaded. See FilePiper for more information. If not set, just a release is being created.	false	empty
release_id	If set, the action will look for an existing release with that id.	false	none
skip_errors	If true, the action will skip errors instead of setting the build to failed.	false	true
draft	If true, the action will create a draft release. (Not published)	false	true
prerelease	If true, the action will create a prerelease.	false	false
overwrite	If true, the action will update already existing assets instead of throwing an error	false	false
tag	The tag of the release.	false	mytag
release_name	The name of the release.	false	My cool release
release_body	The body (description) of the release.	false	This is a very cool release

Outputs

On succeed you will get the release_id as an output.

Usage

Basic multiple file upload:

- name: Pipe files to release
  uses: KotwOSS/pipe-to-release@<version>
  with:
    repo_token: ${{ secrets.GITHUB_TOKEN }}

    # The files that will be uploaded. Use > to specify the file source and the asset name
    filemap: |
      target/release/mything>mything
      target/release/someother>someother

    # Skip errors (doesn't fatal exit, just skips)
    skip_errors: true

    # Creates a release that is not published
    draft: true
    
    # Creates a prerelease
    prerelease: true

    # Replaces assets with the same name instead of throwing an error
    overwrite: true

    # Specifies the tag
    tag: ${{ github.ref }}

    # Specifies the name and the body content of the release
    release_name: This is my release
    release_body: "This is my release text"

    # Specifies a custom repository. (If not set the active repository will be used)
    repository: User/Repository

Multiple file upload with automated tag and release_name:

- name: Generate commit hash
  id: commithash
  run: echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"

- name: Generate build number
  id: buildnumber
    uses: einaregilsson/build-number@v3 
    with:
      token: ${{secrets.GITHUB_TOKEN}}

- name: Pipe files to release
  uses: KotwOSS/pipe-to-release@<version>
  with:
    token: ${{ secrets.GITHUB_TOKEN }}

    filemap: |
      target/release/mything>mything
      target/release/someother>someother

    skip_errors: true

    draft: true
    prerelease: true

    tag: "build_${{ env.BUILD_NUMBER }}"

    release_name: "build:${{ steps.commithash.outputs.sha_short }}"
    release_body: "This is an automated build"

Multiple file upload with automated tag and release_name with matrix:

jobs:
  prepare:
    runs-on: ubuntu-latest
    outputs:
      BUILD_ID: ${{ steps.buildnumber.outputs.build_number }}
      SHA_SHORT: ${{ steps.commithash.outputs.sha_short }}
      RELEASE_ID: ${{ steps.release.outputs.release_id }}

    steps:
      - uses: actions/checkout@v2
      
      - name: Set outputs
        id: commithash
        run: echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
      
      - name: Generate build number
        id: buildnumber
        uses: einaregilsson/build-number@v3 
        with:
          token: ${{ secrets.github_token }}

      - name: Create a release
        id: release
        uses: KotwOSS/pipe-to-release@<version>
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

          skip_errors: true

          draft: true
          prerelease: true

          tag: "build_${{ steps.buildnumber.outputs.build_number }}"
          release_name: "build:${{ steps.commithash.outputs.sha_short }}"
          release_body: "This is an automated build"
          

  buildMatrix:
    name: Publish for ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
  
    strategy:
        fail-fast: false
        matrix:
          include:
          - os: ubuntu-latest
            filemap: |
              target/release/some.deb>some.deb
              target/release/some.AppImage>some.AppImage
                         
          - os: windows-latest
            filemap: |
              target/release/some.exe>some.exe
            
          - os: macos-latest
            filemap: |
              target/release/some.app>some.app
              target/release/some.dmg>some.dmg

    needs: prepare

    steps:
    - uses: actions/checkout@v2

    - name: Pipe files to release
      uses: KotwOSS/pipe-to-release@<version>
      with:
        token: ${{ secrets.GITHUB_TOKEN }}

        filemap: ${{ matrix.filemap }}

        skip_errors: true

        release_id: ${{ needs.prepare.outputs.RELEASE_ID }}

File Piper

File pipers are a combination of <source>, > and <dest> which specify where a file should go.

Examples

Pipe file a to file b -> a>b

Pipe file a> to file b> (escaping > with \>) -> a\>>b\>