Skip to content

Commit 937f6d8

Browse files
committed
improve docstring for release-create
Signed-off-by: Brian DeHamer <bdehamer@github.com>
1 parent d253589 commit 937f6d8

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

pkg/cmd/release/create/create.go

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,19 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
106106
This may result in the same or duplicate release which may not be desirable in some cases.
107107
Use %[1]s--fail-on-no-commits%[1]s to fail if no new commits are available. This flag has no
108108
effect if there are no existing releases or this is the very first release.
109+
110+
## Immutable Releases
111+
112+
When release immutability is enabled for a repository, the following protections are enforced:
113+
- Git tags associated with a release cannot be modified or deleted.
114+
- Release assets cannot be modified or deleted.
115+
116+
Immutability is enforced only after a release is published. Draft releases can be modified
117+
or deleted, and the associated git tags can be modified or deleted as well.
118+
119+
When using the %[1]screate%[1]s command to attach assets to a release, separate API calls
120+
are made to create the release as a draft, upload the assets, and then publish the release.
121+
Immutability protections will be enforced ONLY after the release is published.
109122
`, "`"),
110123
Example: heredoc.Doc(`
111124
# Interactively create a release

0 commit comments

Comments
 (0)