Skip to content

Warning

You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

Lumynous GitHub Release Action

Actions
An action to create GitHub release
v1.0.1
Star (2)

Lumynous GitHub Release Action

This action creates GitHub releases automatically.

Usage

on:
  push:
    branches:
      - main

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      
      - name: Release
        # Use the latest version.
        uses: lumynou5/github-release-action@main
        with:
          token: ${{github.token}}

In this example workflow, it'll create a release whenever push to main branch. The version will be set according to the changelog following Keep a Changelog and Semantic Versioning.

Specifically, a release is created and the tag of the corresponding major version is moved onto that version. If there isn't a tag of the major version, it'll be created.

Inputs

  • token (required) The GitHub token.
  • changelog The path to the changelog. Default: CHANGELOG.md.
  • tag-template The template of the Git tag. Default: v{version}.
  • major-tag-template The template of the Git tag of the major version. Default: v{major}.
  • name-template The template of the GitHub release. Default: v{version}.
  • is-draft If the GitHub release is a draft. Default: false.

The following list shows the arguments can be used in the template.

  • version The version.
  • major The major version.
  • minor The minor version.
  • patch The patch version.
  • prerelease The prerelease name or an empty string.
  • build The build number or an empty string.
  • release-date The release date.

Outputs

The outputs include all the arguments of templates and the following items in addition.

  • html-url The URL to the page of the GitHub release.
  • upload-url The URL to upload assets for the GitHub release.

Lumynous GitHub Release Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

An action to create GitHub release
v1.0.1

Lumynous GitHub Release Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.