diff --git a/README.md b/README.md index 1a38d24e9..b229de3e6 100644 --- a/README.md +++ b/README.md @@ -180,8 +180,8 @@ The following are optional as `step.with` keys | `token` | String | Secret GitHub Personal Access Token. Defaults to `${{ github.token }}` | | `discussion_category_name` | String | If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see ["Managing categories for discussions in your repository."](https://docs.github.com/en/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository) | | `generate_release_notes` | Boolean | Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes. See the [GitHub docs for this feature](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) for more information | -| `append_body` | Boolean | Append to existing body instead of overwriting it | -| `update_tag` | Boolean | Update the tag of the release to the current commit. This will also update the release time. Default is false | +| `append_body` | Boolean | Append to existing body instead of overwriting it | +| `update_tag` | Boolean | Update the tag of the release to the current commit. This will also update the release time. Default is false | 💡 When providing a `body` and `body_path` at the same time, `body_path` will be attempted first, then falling back on `body` if the path can not be read from.