create-release/action.yml

name: 'Create a Release'
description: 'Create a release for a tag in your repository'
author: 'GitHub'
inputs:
  tag_name:
    description: 'The name of the tag. This should come from the webhook payload, `github.GITHUB_REF` when a user pushes a new tag'
    required: true
  release_name:
    description: 'The name of the release. For example, `Release v1.0.1`'
    required: true
  body:
    description: 'Text describing the contents of the tag.'
    required: false
  body_path:
    description: 'Path to file with information about the tag.'
    required: false
  draft:
    description: '`true` to create a draft (unpublished) release, `false` to create a published one. Default: `false`'
    required: false
    default: false
  prerelease:
    description: '`true` to identify the release as a prerelease. `false` to identify the release as a full release. Default: `false`'
    required: false
    default: false
  commitish:
    description: 'Any branch or commit SHA the Git tag is created from, unused if the Git tag already exists. Default: SHA of current commit'
    required: false
  owner:
    description: 'Owner of the repository if it is not the current one'
    required: false
  repo:
    description: 'Repository on which to release.  Used only if you want to create the release on another repo'
    required: false
outputs:
  id:
    description: 'The ID of the created Release'
  html_url:
    description: 'The URL users can navigate to in order to view the release'
  upload_url:
    description: 'The URL for uploading assets to the release'
runs:
  using: 'node12'
  main: 'dist/index.js'
branding:
  icon: 'tag'
  color: 'gray-dark'
Initial commit 2019-09-20 14:55:33 -05:00			`name: 'Create a Release'`
Update action name and description 2019-11-08 16:02:58 +00:00			`description: 'Create a release for a tag in your repository'`
Initial commit 2019-09-20 14:55:33 -05:00			`author: 'GitHub'`
			`inputs:`
			`tag_name:`
			description: 'The name of the tag. This should come from the webhook payload, `github.GITHUB_REF` when a user pushes a new tag'
			`required: true`
			`release_name:`
			description: 'The name of the release. For example, `Release v1.0.1`'
			`required: true`
Include body parameter for release Fixes #4 This adds the ability to include the body parameter when creating the release. - name: Checkout code uses: actions/checkout@master - name: Create Release id: create_release uses: actions/create-release@master with: tag_name: ${{ github.ref }} release_name: Release ${{ github.ref }} body: Release body This also supports a multiline body: - name: Create Release id: create_release uses: actions/create-release@master with: tag_name: ${{ github.ref }} release_name: Release ${{ github.ref }} body: \| This is a multiline body with more than one line Or if you want the contents of a file: - name: Read CHANGELOG id: changelog run: \| echo "::set-output name=body::$(cat CHANGELOG.md)" - name: Create Release id: create_release uses: actions/create-release@master with: release_name: Release ${{ github.ref }} body: ${{ steps.changelog.outputs.body }} One decision I made in favor of less code was to send an empty body when there was non present. If it would be preferred to send nothing in the request for the `body` attribute I could instead compose the parameters with an optional body attribute: releaseParams = { owner, repo, tag_name: tag, name: releaseName, draft, prerelease }; if (body) releaseParams.body = body; const createReleaseResponse = await github.repos.createRelease( releaseParams ); 2019-10-21 11:53:32 -04:00			`body:`
			`description: 'Text describing the contents of the tag.'`
			`required: false`
define body_path 2020-05-26 12:09:33 -07:00			`body_path:`
			`description: 'Path to file with information about the tag.'`
			`required: false`
Initial commit 2019-09-20 14:55:33 -05:00			`draft:`
			description: '`true` to create a draft (unpublished) release, `false` to create a published one. Default: `false`'
			`required: false`
			`default: false`
			`prerelease:`
			description: '`true` to identify the release as a prerelease. `false` to identify the release as a full release. Default: `false`'
			`required: false`
			`default: false`
Tag and release on a specific commitish 2019-12-29 09:06:12 +01:00			`commitish:`
			`description: 'Any branch or commit SHA the Git tag is created from, unused if the Git tag already exists. Default: SHA of current commit'`
			`required: false`
adding owner/repo options for remote releasing 2020-09-11 16:28:30 -05:00			`owner:`
			`description: 'Owner of the repository if it is not the current one'`
			`required: false`
			`repo:`
			`description: 'Repository on which to release. Used only if you want to create the release on another repo'`
			`required: false`
Initial commit 2019-09-20 14:55:33 -05:00			`outputs:`
			`id:`
			`description: 'The ID of the created Release'`
			`html_url:`
			`description: 'The URL users can navigate to in order to view the release'`
			`upload_url:`
			`description: 'The URL for uploading assets to the release'`
			`runs:`
			`using: 'node12'`
			`main: 'dist/index.js'`
			`branding:`
			`icon: 'tag'`
			`color: 'gray-dark'`