2019-08-25 06:14:36 +00:00
|
|
|
# action gh-release [](https://github.com/softprops/action-gh-release/actions)
|
|
|
|
|
|
2019-08-25 06:13:05 +00:00
|
|
|
|
2019-08-25 20:23:19 +00:00
|
|
|
A Github Action for creating Github Releases
|
2019-08-25 06:17:36 +00:00
|
|
|
|
2019-08-25 19:24:49 +00:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
name: Main
|
|
|
|
|
|
|
|
|
|
on: push
|
|
|
|
|
|
|
|
|
|
jobs:
|
|
|
|
|
build:
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
steps:
|
|
|
|
|
- name: Checkout
|
|
|
|
|
uses: actions/checkout@master
|
|
|
|
|
- name: Build
|
|
|
|
|
run: echo ${{ github.sha }} > Release.txt
|
|
|
|
|
- name: Release
|
|
|
|
|
uses: docker://softprops/action-gh-release
|
2019-08-25 22:37:27 +00:00
|
|
|
if: startsWith(github.ref, 'refs/tags/')
|
2019-08-25 19:25:36 +00:00
|
|
|
with:
|
|
|
|
|
files: Release.txt
|
2019-08-25 19:24:49 +00:00
|
|
|
env:
|
|
|
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
|
```
|
|
|
|
|
|
2019-08-26 02:32:14 +00:00
|
|
|
## inputs
|
|
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
|
|---------|---------|---------------------------------------------------------------|
|
|
|
|
|
| `body` | String | text communicating notable changes in this release |
|
|
|
|
|
| `draft` | Boolean | indicator of whether or not this release is a draft |
|
|
|
|
|
| `files` | String | comma-delimited globs of paths to assets to upload for release|
|
|
|
|
|
| `name` | String | name of the release. defaults to tag name |
|
|
|
|
|
|
|
|
|
|
## environment variables
|
|
|
|
|
|
|
|
|
|
| Name | Description |
|
|
|
|
|
|----------------|--------------------------------------|
|
|
|
|
|
| `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets`|
|
|
|
|
|
|
2019-08-25 06:17:36 +00:00
|
|
|
Doug Tangren (softprops) 2019
|
