GitHub Action - Get a Releases

This GitHub Action (written in JavaScript) wraps the GitHub Release API, specifically the Get a Release endpoint, to allow you to leverage GitHub Actions to get releases.

Usage

Pre-requisites

Create a workflow .yml file in your .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.

Outputs

For more information on these outputs, see the API Documentation for an example of what these outputs look like

• id: The release ID
• html_url: The URL users can navigate to in order to view the release. i.e. https://github.com/octocat/Hello-World/releases/v1.0.0
• upload_url: The URL for uploading assets to the release, which could be used by GitHub Actions for additional uses, for example the @actions/upload-release-asset GitHub Action

Example workflow - get a release

On every push to a tag matching the pattern v*, create a release:

on:
  push:
    # Sequence of patterns matched against refs/tags
    tags:
      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10

name: Create Release

env:
  GITHUB_TOKEN: ${{ github.token }}

jobs:
  build:
    name: Get Release
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@master
      - name: Get Release
        id: get
        uses: bruceadams/get-release@v1

License

The scripts and documentation in this project are released under the MIT License