actions/release-action
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update immutableCreate's default in the documentation (#547)

Browse Source 
The default of `immutableCreate` changed from `true` to `false` in version 1.9.1
This commit is contained in:
Benoît Blanchon
2025-09-02 14:11:01 +02:00
committed by GitHub
parent 1c89adf398
commit 571fe81601
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -25,7 +25,7 @@ This action will create a GitHub release and optionally upload an artifact to it
| discussionCategory | When provided this will generate a discussion of the specified category. The category must exist otherwise this will cause the action to fail. This isn't used with draft releases. The default "Announcements" category is not supported via the API and will cause an error if used here. | false | "" | | discussionCategory | When provided this will generate a discussion of the specified category. The category must exist otherwise this will cause the action to fail. This isn't used with draft releases. The default "Announcements" category is not supported via the API and will cause an error if used here. | false | "" |
| draft | Optionally marks this release as a draft release. Set to true to enable. | false | "" | | draft | Optionally marks this release as a draft release. Set to true to enable. | false | "" |
| generateReleaseNotes | Indicates if release notes should be automatically generated. | false | false | | generateReleaseNotes | Indicates if release notes should be automatically generated. | false | false |
| immutableCreate | Indicates if immutable release creation should be used. When enabled, the action will first create a draft, upload artifacts, then publish the release. | false | true | | immutableCreate | Indicates if immutable release creation should be used. When enabled, the action will first create a draft, upload artifacts, then publish the release. | false | false |
| makeLatest | Indicates if the release should be the "latest" release or not. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version. | false | "legacy" | | makeLatest | Indicates if the release should be the "latest" release or not. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version. | false | "legacy" |
| name | An optional name for the release. If this is omitted the tag will be used. | false | "" | | name | An optional name for the release. If this is omitted the tag will be used. | false | "" |
| omitBody | Indicates if the release body should be omitted. | false | false | | omitBody | Indicates if the release body should be omitted. | false | false |

2
README.zh-Hans.md
View File

@@ -26,7 +26,7 @@
| discussionCategory | 当提供该选项时，将生成指定类别的 discussion。指定的类别必须存在，否则将导致 Action 失败。这对草案状态的发布不生效。API 不支持默认的 Announcement 分类，使用这个分类会引发错误。 | false | "" | | discussionCategory | 当提供该选项时，将生成指定类别的 discussion。指定的类别必须存在，否则将导致 Action 失败。这对草案状态的发布不生效。API 不支持默认的 Announcement 分类，使用这个分类会引发错误。 | false | "" |
| draft | 可选择将此版本标记为草稿版本。 设置为 true 以启用。 | false | "" | | draft | 可选择将此版本标记为草稿版本。 设置为 true 以启用。 | false | "" |
| generateReleaseNotes | 指示是否应自动生成发行说明。 | false | false | | generateReleaseNotes | 指示是否应自动生成发行说明。 | false | false |
| immutableCreate | 指示是否应使用不可变发布创建。启用时，操作将首先创建草稿，上传产出文件，然后发布版本。 | false | true | | immutableCreate | 指示是否应使用不可变发布创建。启用时，操作将首先创建草稿，上传产出文件，然后发布版本。 | false | false |
| makeLatest | 指示是否将这个发布设置为 latest。使用"lagecy"值则会根据发布时间和语义化版本号自动决定。 | false | "legacy" | | makeLatest | 指示是否将这个发布设置为 latest。使用"lagecy"值则会根据发布时间和语义化版本号自动决定。 | false | "legacy" |
| name | 版本的可选名称。 如果省略，将使用标签。 | false | "" | | name | 版本的可选名称。 如果省略，将使用标签。 | false | "" |
| omitBody | 指示是否应省略发布主体。 | false | false | | omitBody | 指示是否应省略发布主体。 | false | false |

2
action.yml
View File

@@ -50,7 +50,7 @@ inputs:
immutableCreate: immutableCreate:
description: 'Indicates if immutable release creation should be used. When enabled, the action will first create a draft, upload artifacts, then publish the release.' description: 'Indicates if immutable release creation should be used. When enabled, the action will first create a draft, upload artifacts, then publish the release.'
required: false required: false
default: 'true' default: 'false'
makeLatest: makeLatest:
description: 'Indicates if the release should be the "latest" release or not.' description: 'Indicates if the release should be the "latest" release or not.'
required: false required: false