mirror of https://github.com/actions/create-release.git synced 2025-06-14 21:07:43 +00:00

Go to file

Christopher Sexton becafb2f61 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-22 12:24:23 -04:00

.github/workflows

Setup CI

2019-09-20 15:16:57 -05:00

dist

Include body parameter for release

2019-10-22 12:24:23 -04:00

src

Include body parameter for release

2019-10-22 12:24:23 -04:00

tests

Include body parameter for release

2019-10-22 12:24:23 -04:00

.eslintrc

Update dev dependencies, add ESLint

2019-09-20 15:07:18 -05:00

.gitignore

Initial commit

2019-09-20 14:55:33 -05:00

action.yml

Include body parameter for release

2019-10-22 12:24:23 -04:00

CODE_OF_CONDUCT.md

Initial commit

2019-09-20 14:55:33 -05:00

CONTRIBUTING.md

Update CONTRIBUTING.md

2019-10-20 17:47:47 -05:00

LICENSE

Initial commit

2019-09-20 14:55:33 -05:00

package-lock.json

Update dev dependencies, add ESLint

2019-09-20 15:07:18 -05:00

package.json

Refactor main.js for test coverage

2019-09-27 14:19:53 -05:00

README.md

Include body parameter for release

2019-10-22 12:24:23 -04:00

README.md

GitHub Action - Releases API

This GitHub Action (written in JavaScript) wraps the GitHub Release API, specifically the Create a Release endpoint, to allow you to leverage GitHub Actions to create releases.

Usage

Pre-requisites

Create a workflow .yml file in your repositories .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.

Inputs

For more information on these inputs, see the API Documentation

tag_name: The name of the tag for this release
release_name: The name of the release
body: Text describing the contents of the release
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

Outputs

For more information on these outputs, see the API Documentation for an example of what these outputs look like

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

Example workflow - create a release

On every push to a tag matching the pattern v*, create a release:

on:
  push:
    # Sequence of patterns matched against refs/tags
    tags:
      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10

name: Create Release

jobs:
  build:
    name: Create Release
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@master
      - name: Create Release
        id: create_release
        uses: actions/create-release@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          tag_name: ${{ github.ref }}
          release_name: Release ${{ github.ref }}
          body: |
            Changes in this Release
            - First Change
            - Second Change
          draft: false
          prerelease: false

This will create a Release, as well as a release event, which could be handled by a third party service, or by GitHub Actions for additional uses, for example the `@actions/upload-release-asset GitHub Action.

Contributing

We would love you to contribute to @actions/create-release, pull requests are welcome! Please see the CONTRIBUTING.md for more information.

License

The scripts and documentation in this project are released under the MIT License