Skip to content

Reusable action for LizardByte to publish a GitHub release.

License

Notifications You must be signed in to change notification settings

LizardByte/create-release-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

create-release-action

GitHub Workflow Status (CI)

A reusable action to create a GitHub release. This action is tailored to the @LizardByte organization, but can be used by anyone if they follow the same conventions.

This is basically a wrapper around ncipollo/release-action, with some different defaults to make it easier to use within the @LizardByte organization. Additionally, all except the 2 (configurable) latest pre-releases and tags are deleted.

Basic Usage

See action.yml

steps:
  - name: Create Release
    uses: LizardByte/create-release-action@master
    with:
      name: v0.1.0
      tag: v0.1.0
      token: ${{ secrets.GITHUB_TOKEN }}

Inputs

Name Description Default Required
allowUpdates An optional flag which indicates if we should update a release if it already exists. true false
artifactErrorsFailBuild An optional flag which indicates if we should fail the build if there are errors with the artifacts. false false
artifacts The artifacts to upload. *artifacts/* false
body The body of the release. false
deleteOtherPreReleases Whether to delete other pre-releases. true false
deletePreReleaseTags Whether to delete other pre-release tags. true false
generateReleaseNotes Indicates if release notes should be automatically generated. true false
keepPreReleaseCount The number of pre-releases to keep. 2 false
name The version to create. true
prerelease Whether the release is a prerelease. true false
sleepDuration The duration to sleep in seconds before deleting tags. 15 false
tag The tag to create. true
token GitHub Token. true

See Also

This action is meant to be used in conjunction with LizardByte/setup-release-action.