You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Automatic GitHub Release
2.0.1
Automatically generate a release when the package.json version changes. The release name and tag will match the new version. If no releases yet exist, this action will create the first release.
The release notes will contain a change log generated from git history in the following format:
- f0d91bd Making progress
- 275e3e2 Initial commit
This action makes a few assumptions:
actions/checkout@v2
withfetch-depth: 0
is used before this action runs. That allows this action to have all the information it needs to generate the change log from the git history.- You are only releasing from one branch
- It is only used during
push
name: Release
on:
push:
branches:
- master
jobs:
build:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Release
uses: justincy/github-action-npm-release@v1.2.0
id: release
- name: Print release output
if: ${{ steps.release.outputs.released == 'true' }}
run: echo Release ID ${{ steps.release.outputs.release_id }}
token
: Personal access token for GitHub authentication. Optional. Defaults to${{ github.token }}
.path
: Path of the package.json file that will be examined. Optional. Defaults to${{ github.workspace }}
.
released
: Set to true when a release is created.html_url
: The URL for viewing the release in a browser.upload_url
: The URL for uploading assets to the release.release_id
: ID of the release.release_tag
: Tag of the release.release_name
: Name of the release.
- Add options for draft and pre-release
- Add option for custom git-log format