Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Improve docstring for release-create #11945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 22, 2025
Merged

Improve docstring for release-create #11945

merged 1 commit into from
Oct 22, 2025
+13 −0

Conversation

@bdehamer
Copy link
Contributor

Updates the docstring for the gh release create command to include some specific information about immutable releases:

## Immutable Releases

When release immutability is enabled for a repository, the following protections are enforced:
- Git tags associated with a release cannot be modified or deleted.
- Release assets cannot be modified or deleted.

Immutability is enforced only after a release is published. Draft releases can be modified
or deleted, and the associated git tags can be modified or deleted as well.

When using the `create` command to attach assets to a release, separate API calls
are made to create the release as a draft, upload the assets, and then publish the release.
Immutability protections will be enforced ONLY after the release is published.

Copilot AI review requested due to automatic review settings October 16, 2025 18:57
@bdehamer bdehamer requested a review from a team as a code owner October 16, 2025 18:57
@bdehamer bdehamer requested a review from babakks October 16, 2025 18:57
Copilot AI reviewed Oct 16, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the documentation for the gh release create command by adding a new "Immutable Releases" section that explains how release immutability protections work in GitHub repositories.

Key Changes:

  • Added comprehensive documentation about immutable release protections
  • Clarified that immutability is only enforced after a release is published, not for drafts
  • Explained the multi-step process of creating releases with assets and when protections apply

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@cliAutomation cliAutomation added the external pull request originating outside of the CLI core team label Oct 16, 2025
@cliAutomation
Copy link
Collaborator

Hi! Thanks for the pull request. Please ensure that this change is linked to an issue by mentioning an issue number in the description of the pull request. If this pull request would close the issue, please put the word 'Fixes' before the issue number somewhere in the pull request body. If this is a tiny change like fixing a typo, feel free to ignore this message.

babakks
babakks approved these changes Oct 16, 2025
View reviewed changes
Copy link
Member

@babakks babakks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚢

@bdehamer bdehamer merged commit 0579d74 into trunk Oct 22, 2025
15 checks passed
@bdehamer bdehamer deleted the bdehamer/gh-release-create-docs branch October 22, 2025 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@babakks babakks babakks approved these changes

Assignees

No one assigned

Labels

external pull request originating outside of the CLI core team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@bdehamer @cliAutomation @babakks