mirrors/action-gh-release
1
0
Fork 1
mirror of https://github.com/softprops/action-gh-release.git synced 2025-05-11 10:54:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document id input and draft/publish example

Browse source
This commit is contained in:
patrick brisbin 2023-05-26 12:31:10 -04:00
parent aad5059670
commit f4edb098d2
No known key found for this signature in database
GPG key ID: 07BF97A312D7F34C
1 changed files with 41 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -161,6 +161,46 @@ jobs:
GITHUB_REPOSITORY: my_gh_org/my_gh_repo GITHUB_REPOSITORY: my_gh_org/my_gh_repo
``` ```
### Draft ⇒ Upload ⇒ Publish
This action can be used to create a draft Release, upload assets (or do other
processing), then publish the Release only after that work is done. Because of
how finding existing Releases and the `draft` input interact, you need to pass
the `id` output from the create step as input to the update steps.
```yaml
jobs:
create:
runs-on: ubuntu-latest
steps:
- id: create
uses: softprops/action-gh-release@v1
with:
tag_name: "..."
draft: true
outputs:
release_id: ${{ steps.create.outputs.id }}
upload:
needs: create
runs-on: ubuntu-latest
steps:
# build the thing...
- uses: softprops/action-gh-release@v1
with:
id: ${{ needs.create.outputs.release_id }}
files: "..."
publish:
needs: create
runs-on: ubuntu-latest
steps:
- uses: softprops/action-gh-release@v1
with:
id: ${{ needs.create.outputs.release_id }}
draft: false
```
### 💅 Customizing ### 💅 Customizing
#### inputs #### inputs
@ -174,6 +214,7 @@ The following are optional as `step.with` keys
| `draft` | Boolean | Indicator of whether or not this release is a draft | | `draft` | Boolean | Indicator of whether or not this release is a draft |
| `prerelease` | Boolean | Indicator of whether or not is a prerelease | | `prerelease` | Boolean | Indicator of whether or not is a prerelease |
| `files` | String | Newline-delimited globs of paths to assets to upload for release | | `files` | String | Newline-delimited globs of paths to assets to upload for release |
| `id` | Number | Id to an existing release you want to update |
| `name` | String | Name of the release. defaults to tag name | | `name` | String | Name of the release. defaults to tag name |
| `tag_name` | String | Name of a tag. defaults to `github.ref` | | `tag_name` | String | Name of a tag. defaults to `github.ref` |
| `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing | | `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing |