Upload Release Asset

A production-ready GitHub Composable Action that automatically uploads assets to a release.

Since actions/upload-release-asset@v1 has been archived and is stuck on node12 (now deprecated), I created this GitHub Action to do the same job but using only the GitHub API via CRUL.

I have kept the actions/upload-release-asset@v1's interface to make migration easier.

- uses: ./.github/actions/upload-release-asset
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:
    upload_url: ${{ github.event.release.upload_url }}
    asset_path: path/to/asset/example.zip
    asset_name: example-${{ github.ref_name }}.zip
    asset_content_type: application/zip

For an idea of how you would use this in your own project, see Versioning & Releasing and .github/workflows/release-actions-workflow.yml.

Please feel free to submit any improvements.

Versioning & Releasing

As releasing builds on versioning, first create a version, then release it if the version is okay.

Versioned deployments

To deploy a new version, a tag should be created following semantic versioning rules and prefixed with "v". Eg, "v1.0.2-beta".

Once pushed, the distribution workflow will run (just a demo run in this project).

For example, tag "v1.0.2-beta" could create resources such as documentation websites for the tag.

Releases

In this project, releases are first created from the Github Release page. Then this will trigger the .github/workflows/release-actions-workflow.yml workflow, automatically attaching the following assets to the release.

• LICENSE
• upload-release-asset.zip

Releasable versions should always be created from the main "trunk" branch.

To create a release, a version must first be tagged and pushed. Once pushed, the tag can be selected from the new release page.

Next, enter a release title (typically the version number) and a description of the changes - this should include any breaking changes and migration information.

Note that the GITHUB_TOKEN must have read and write access to the repository.