diff --git a/README.md b/README.md index ac9ab85..d2e16be 100644 --- a/README.md +++ b/README.md @@ -185,7 +185,7 @@ The following are optional as `step.with` keys | `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 | -| `preserve_order` | Boolean | Indicator of whether order of files should be preserved when uploading assets | +| `preserve_order` | Boolean | Upload assets sequentially in the provided order. This controls the action's upload behavior, but it does not control the final asset ordering that GitHub may display on the release page or return from the Releases API. | | `files` | String | Newline-delimited globs of paths to assets to upload for release | | `overwrite_files` | Boolean | Indicator of whether files should be overwritten when they already exist. Defaults to true | | `name` | String | Name of the release. defaults to tag name | diff --git a/action.yml b/action.yml index 2175241..5dc4405 100644 --- a/action.yml +++ b/action.yml @@ -22,7 +22,7 @@ inputs: description: "Identify the release as a prerelease. Defaults to false" required: false preserve_order: - description: "Preserver the order of the artifacts when uploading" + description: "Upload artifacts sequentially in the provided order. This does not control the final display order GitHub uses for release assets." required: false files: description: "Newline-delimited list of path globs for asset files to upload"