https://github.com/avakar/tag-and-release

Automatically create tags and corresponding releases
https://github.com/avakar/tag-and-release

github-actions release-automation

Last synced: 2 days ago
JSON representation

Automatically create tags and corresponding releases

• Host: GitHub
• URL: https://github.com/avakar/tag-and-release
• Owner: avakar
• License: mit
• Created: 2020-02-14T20:49:24.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-10-28T10:42:56.000Z (about 2 years ago)
• Last Synced: 2024-11-04T14:04:11.332Z (3 days ago)
• Topics: github-actions, release-automation
• Language: JavaScript
• Homepage:
• Size: 78.1 KB
• Stars: 9
• Watchers: 3
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Action – Tag and Release

Automatically create tags and corresponding releases.

## Usage

This action is meant to be invoked in response to a branch push to create

a tag and a corresponding release, under the assumption that you can derive

the tag name automatically.

In contrast,

[`actions/create-release`](https://github.com/actions/create-release)

is generally run on a tag push, expects the tag to already exist

and only creates the release.

The only mandatory input parameter is the tag name.

    on: push

    jobs:

      release:

        runs-on: ubuntu-latest

        steps:

          - uses: avakar/tag-and-release@v1

            with:

              tag_name: ${{ ... }}

            env:

              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

### Inputs

* `tag_name`: the name of the tag to be created

* `release_name`: the name of the new release; if omitted, defaults to `tag_name`

* `commit`: the commit to which the new tag should point, defaults to `${{ GITHUB_SHA }}`

* `body`: optional text of the release body

* `draft`: set to `true` to create an unpublished (draft) release; defaults to `false`

* `prerelease`: whether the release should be marked as a prerelease.

### Outputs

* `id`: the ID of the release

* `html_url`: the human-readable web-page of the release, e.g. `https://github.com/avakar/tag-and-release/releases/v1.0.0`

* `upload_url`: the URL you can give to `@actions/upload-release-asset`