setup-hc-releases

GitHub Action to install hc-releases. Note that v1 of this action is now deprecated, and v2 must be used.

Usage

jobs:
  Release:
    runs-on: ubuntu-latest
    steps:
      # ... potentially other steps ...
      - uses: hashicorp/setup-hc-releases@v2
        with:
          github-token: ${{ secrets.HC_RELEASES_GITHUB_TOKEN }}
      # ... steps that require hc-releases ...

Inputs

Input	Description	Default
github-token	GitHub token with release asset access to hc-releases.
version	Version of hc-releases to install.	Latest release

Outputs

Output	Description
version	Version of hc-releases installed.

Development

Test locally with act. You'll need a GitHub token authorized to download release assets from the releases-api repository.

act --container-architecture=linux/amd64 --input github-token=$(gh auth token) workflow_dispatch

The default version is set to avoid failed workflows if a broken hc-releases is published but can be passed explicitly for testing.

Creating a Release

After your PR is merged to the default branch, main:

1. Update locally: git checkout main && git pull
2. Create a new tag for the release, e.g. v2.0.1 with git tag v2.0.1 && git push origin v2.0.1.
3. Update the major version tag locally, e.g. git tag -d v2 && git tag v2
4. Update the tag upstream, e.g. git push origin :refs/tags/v2 && git push origin v2