Repository files navigation

Please note: This repository is currently unmaintained by a team of developers at GitHub. Therepository is here and you can use it as an example, or in Actions. However please be aware thatwe are not going to be updating issues or pull requests on this repository.

Maintained Actions:

• elgohr/Github-Release-Action
• marvinpinto/action-automatic-releases
• softprops/action-gh-release
• ncipollo/release-action

To reflect this state we’ve marked this repository as Archived.

If you are having an issue or question about GitHub Actions then pleasecontact customer support.

If you have found a security issueplease submit it here.

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

Create a workflow.yml file in your.github/workflows directory. Anexample workflow is available below. For more information, reference the GitHub Help Documentation forCreating a workflow file.

For more information on these inputs, see theAPI 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. Optional, and not needed if usingbody_path.
• body_path: A file with contents describing the release. Optional, and not needed if usingbody.
• 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
• 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

Thebody_path is valuable for dynamically creating a.md within code commits and even within the Github Action steps leading up to thecreate-release.

For more information on these outputs, see theAPI 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

On everypush to a tag matching the patternv*,create a release:

on:push:# Sequence of patterns matched against refs/tagstags:      -'v*'# Push events to matching v*, i.e. v1.0, v20.15.10name:Create Releasejobs:build:name:Create Releaseruns-on:ubuntu-lateststeps:      -name:Checkout codeuses:actions/checkout@v2      -name:Create Releaseid:create_releaseuses:actions/create-release@v1env:GITHUB_TOKEN:${{ secrets.GITHUB_TOKEN }}# This token is provided by Actions, you do not need to create your own tokenwith:tag_name:${{ github.ref }}release_name:Release ${{ github.ref }}body:|            Changes in this Release            - First Change            - Second Changedraft:falseprerelease:false

This will create aRelease, as well as arelease 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. This uses theGITHUB_TOKEN provided by thevirtual environment, so no new token is needed.

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

The scripts and documentation in this project are released under theMIT License