actions/create-release
1
0
Fork 0
mirror of https://github.com/actions/create-release.git synced 2025-06-14 12:57:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme with body_path

Browse Source
This commit is contained in:
Jacob Bolda 2020-04-11 23:19:42 -05:00
parent 7424051c44
commit 9d21c8a3f2
No known key found for this signature in database
GPG Key ID: 22CE5B1A2BD487F7
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -12,13 +12,13 @@ For more information on these inputs, see the [API Documentation](https://develo
- `tag_name`: The name of the tag for this release - `tag_name`: The name of the tag for this release
- `release_name`: The name of the release - `release_name`: The name of the release
- `body`: Text describing the contents of the release. Optional, and not needed if using `bodyFromFile`. - `body`: Text describing the contents of the release. Optional, and not needed if using `body_path`.
- `bodyFromFile`: A file with contents describing the release. Optional, and not needed if using `body`. - `body_path`: A file with contents describing the release. Optional, and not needed if using `body`.
- `draft`: `true` to create a draft (unpublished) release, `false` to create a published one. Default: `false` - `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` - `prerelease`: `true` to identify the release as a prerelease. `false` to identify the release as a full release. Default `false`
#### `bodyFromFile` #### `body_path`
The `bodyFromFile` is valuable for dynamically creating a `.md` within code commits and even within the Github Action steps leading up to the `create-release`. The `body_path` is valuable for dynamically creating a `.md` within code commits and even within the Github Action steps leading up to the `create-release`.
### Outputs ### Outputs
For more information on these outputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#response-4) for an example of what these outputs look like For more information on these outputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#response-4) for an example of what these outputs look like