Skip to content

Commit 7ee8e06

Browse files
authored
declare an update docs for make_latest input (#419)
1 parent d99959e commit 7ee8e06

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ The following are optional as `step.with` keys
183183
| `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) |
184184
| `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 |
185185
| `append_body` | Boolean | Append to existing body instead of overwriting it |
186-
| `make_latest` | Boolean | Whether to mark the release as latest or not. |
186+
| `make_latest` | String | Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Can be `true`, `false`, or `legacy`. Uses GitHub api defaults if not provided |
187187

188188
💡 When providing a `body` and `body_path` at the same time, `body_path` will be
189189
attempted first, then falling back on `body` if the path can not be read from.
@@ -196,11 +196,11 @@ release will retain its original info.
196196

197197
The following outputs can be accessed via `${{ steps.<step-id>.outputs }}` from this action
198198

199-
| Name | Type | Description |
200-
| ------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
201-
| `url` | String | Github.com URL for the release |
202-
| `id` | String | Release ID |
203-
| `upload_url` | String | URL for uploading assets to the release |
199+
| Name | Type | Description |
200+
| ------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
201+
| `url` | String | Github.com URL for the release |
202+
| `id` | String | Release ID |
203+
| `upload_url` | String | URL for uploading assets to the release |
204204
| `assets` | String | JSON array containing information about each uploaded asset, in the format given [here](https://docs.github.com/en/rest/releases/assets#get-a-release-asset) (minus the `uploader` field) |
205205

206206
As an example, you can use `${{ fromJSON(steps.<step-id>.outputs.assets)[0].browser_download_url }}` to get the download URL of the first asset.

action.yml

+3
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ inputs:
4646
append_body:
4747
description: "Append to existing body instead of overwriting it. Default is false."
4848
required: false
49+
make_latest:
50+
description: "Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Can be `true`, `false`, or `legacy`. Uses GitHub api default if not provided"
51+
required: false
4952
env:
5053
"GITHUB_TOKEN": "As provided by Github Actions"
5154
outputs:

0 commit comments

Comments
 (0)