boite-nl / query-release-action

Github Action to query Github Releases

Query Github Releases Action

Github Action to Query Github releases and retrieve information about this release which can be used in other actions.

Contents

• Action
  • Inputs
  • Environment Variables
  • Outputs
  • Runs
• Use Cases
  • Deploy specific release to environment
  • Rollback action

Action

Inputs

parameter	description	required	default
token	Token for the repository. Can be passed in using {{ secrets.GITHUB_TOKEN }}.	false	${{ github.token }}
draft	Get Draft Release	false	false
exclude-draft	Exclude Draft Releases	false
prerelease	Get Prerelease	false	false
range	Get Semver Versions from within a specific Range	false
release	Get Release	false	false
select	Which release do you want to retrieve? (latest, previous, oldest, max, min, specific release)	false	latest

Environment Variables

ENV VAR	Description	Required	Default
GITHUB_REPOSITORY	The Repository name	true	-
GITHUB_REPOSITORY_OWNER	The repository owner's name	true	-
GITHUB_API_URL	The API URL	false	https://api.github.com
GITHUB_TOKEN	Token for executing the action, can also be set through inputs	true	${{ inputs.token }}

Outputs

parameter	description
found	A release is found
id	The Release ID
name	The name for the release
tag_name	The tag name for the release
body	Description of the Release
url	The URL of the Release

Runs

This action is a node16 action.

Use Cases

Deploy specific release to environment

on:
  workflow_dispatch:
    inputs:
      version:
        description: The version to release
        default: previous
        required: false
        type: string
      environment:
        description: The environment to which to release
        default: production
        required: false
        type: string

jobs:
  deploy-release:
    runs-on: ubuntu-latest

    steps:
      - name: Get Release
        uses: query-github-release@v1
        id: get-release
        with:
          release: true
          select: ${{ inputs.version }}
      - uses: actions/checkout@v3
        if: steps.get-release.outputs.tag_name
        with:
          fetch-depth: 1
          ref: refs/tags/${{ steps.get-release.outputs.tag_name }}
      - name: "Deploy to environment: ${{ inputs.environment }}"
        run: |
          Deploying ${{ steps.get-release.outputs.tag_name }} to environment: ${{ inputs.environment }}

Rollback action

on:
  workflow_dispatch:
    inputs:
      version:
        description: The version to rollback to
        default: previous
        required: false
        type: string

jobs:
  rollback:
    runs-on: ubuntu-latest

    steps:
      - name: Get Release to Rollback to
        uses: query-github-release@v1
        id: get-release
        with:
          release: true
          select: ${{ inputs.version }}
      - name: Rollback action
        if: steps.get-release.outputs.tag_name
        run: |
          echo "Rolling back to: ${{ steps.get-release.outputs.tag_name }}"

query-release-action's Issues

Additional tags

Report for refs/heads/main

Thanks for Using Readable Readme

This report is auto-generated by readable-readme to help your team improve the quality of READMEs.