Skip to content

Latest commit

 

History

History
126 lines (80 loc) · 4.18 KB

README.md

File metadata and controls

126 lines (80 loc) · 4.18 KB
Raw

test

Yet Another Create Release Action

This GitHub Action creates a release. actions/create-release is a great action, but it is currently unmaintained. So I created another one.

SYNOPSIS

The action is compatible with actions/create-release. It will work just by replacing the workflow's actions/create-release with shogo82148/actions-create-release.

on:
  push:
    tags:
      - "v*"

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Create Release
        uses: shogo82148/actions-create-release@v1

Inputs

tag_name

The name of the tag for this release. The default is the tag name that triggered the workflow.

release_name

The name of the release.

body

Text describing the contents of the release. Optional, and not needed if using body_path.

body_path

A file with contents describing the release. Optional, and not needed if using body.

draft

true to create a draft (unpublished) release, false to create a published one. Default: false.

prerelease

true to identify the release as a prerelease. false to identify the release as a full release. Default: false.

make_latest

Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to automatic based on date and version. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version.

commitish

Any branch or commit SHA the Git tag is created from, unused if the Git tag already exists. Default: SHA of current commit.

owner

The name of the owner of the repo. Used to identify the owner of the repository. Used when cutting releases for external repositories. Default: Current owner.

repo

The name of the repository. Used to identify the repository on which to release. Used when cutting releases for external repositories. Default: Current repository

discussion_category_name

If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "Managing categories for discussions in your repository."

generate_release_notes

Whether to automatically generate the name and body for this release. If release_name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body or body_path is specified, the body will be pre-pended to the automatically generated notes. For more information, see "Automatically generated release notes".

notes_start_tag

The start tag for release notes generation.

overwrite

Whether to overwrite the release if it already exists. The default value is false.

Outputs

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 shogo82148/actions-upload-release-asset GitHub Action

Related works