download-release-asset's Introduction

Download release assets

Use this action to download assets from a release in any github project that you can access.

Usage

To download any test-*.txt file into the pwd, from the latest release within the current repository:

steps:
  - uses: PlasmoHQ/[email protected]
    with:
      files: test-*.txt

To download any test-*.md and foo-*.zip file from another repository, with a specific release tag, into a download directory:

steps:
  - uses: PlasmoHQ/[email protected]
    with:
      files: |
        test-*.md
        foo-*.zip
      repository: PlasmoHQ/test-repo
      tag: v1.0.0
      target: download/
      token: ${{ secrets.GITHUB_TOKEN }}

Implementation notes

We decided to build this action because when searching for a "github release file download" action in a couple of search engine, we couldn't find one that fits our need.

While implementing the code to download the asset however, we found this issue octokit/rest.js/issues/6#issuecomment-477800969, which has a reference to an issue pointing to download-github-release-assets.

Since that action does not use TypeScript, we decided to go ahead with the release of our own.