From 0aec73c6d683a52b9be6e20fa23177b5b043c4e9 Mon Sep 17 00:00:00 2001 From: softprops Date: Sun, 8 Aug 2021 11:57:10 -0400 Subject: [PATCH] document discussion link input --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f9d8867..b61e8a5 100644 --- a/README.md +++ b/README.md @@ -165,19 +165,19 @@ jobs: The following are optional as `step.with` keys -| Name | Type | Description | -| ------------------------- | ------- | --------------------------------------------------------------------------------------------------- | -| `body` | String | Text communicating notable changes in this release | -| `body_path` | String | Path to load text communicating notable changes in this release | -| `draft` | Boolean | Indicator of whether or not this release is a draft | -| `prerelease` | Boolean | Indicator of whether or not is a prerelease | -| `files` | String | Newline-delimited globs of paths to assets to upload for release | -| `name` | String | Name of the release. defaults to tag name | -| `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 | -| `target_commitish` | String | Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. | -| `token` | String | Secret GitHub Personal Access Token. Defaults to `${{ github.token }}` | -| `discussion_category_name` | String | | +| Name | Type | Description | +| -------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `body` | String | Text communicating notable changes in this release | +| `body_path` | String | Path to load text communicating notable changes in this release | +| `draft` | Boolean | Indicator of whether or not this release is a draft | +| `prerelease` | Boolean | Indicator of whether or not is a prerelease | +| `files` | String | Newline-delimited globs of paths to assets to upload for release | +| `name` | String | Name of the release. defaults to tag name | +| `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 | +| `target_commitish` | String | Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. | +| `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) | 💡 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.