Display immutable field in `release view` command #11251

bdehamer · 2025-07-08T16:38:13Z

Updates the release view command to expose the isImmutable field for releases.

This field indicates whether or not a given release is immutable.

Examples

gh release view with JSON fields:

$ gh release view v1 --json "name,isImmutable"
{
  "isImmutable": true,
  "name": "v1"
}

gh release view with no TTY:

$ gh release view v1 | cat               
title:	v1
tag:	v1
draft:	false
prerelease:	false
immutable:	true
author:	bdehamer
created:	2025-06-23T20:37:31Z
published:	2025-06-23T20:45:02Z
url:	https://github.com/bdehamer/releases-demo/releases/tag/v1
asset:	artifact.zip
--
### New Features
. . .

cliAutomation · 2025-07-08T16:38:25Z

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.

Copilot

Pull Request Overview

This PR adds support for displaying the isImmutable field in GitHub CLI release commands. The field indicates whether a release is immutable and cannot be modified.

Exposes isImmutable field in both release list and release view commands
Updates JSON output to include the immutable status
Adds plain text display of immutable status in release view

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
pkg/cmd/release/shared/fetch.go	Adds `isImmutable` to ReleaseFields and Release struct
pkg/cmd/release/view/view.go	Updates plain text output to display immutable status
pkg/cmd/release/view/view_test.go	Adds test coverage for immutable field in JSON fields and view output
pkg/cmd/release/list/http.go	Adds `isImmutable` field to list command's Release struct
pkg/cmd/release/list/list_test.go	Updates JSON export test to include immutable field

pkg/cmd/release/list/http.go

babakks

Thanks @bdehamer for opening up this PR! 🙏

The changes seems good, but it's not yet complete because the immutable field is not supported on GHES, and shipping this will break release list when it's run against GHES:

GH_HOST=ghe.io go run ./cmd/gh release list -R babakks/foo 
# GraphQL: Field 'immutable' doesn't exist on type 'Release' (query RepositoryReleaseList.repository.releases.nodes.immutable)

To resolve this, we need to use feature detection (which has to be updated for this purpose) and select the immutable field if it's supported.

Now, can you please tell me about the priority/urgency of this change? So that we can decide about bringing this into our planning, which is already packed.

UPDATE: On the other hand, the REST API (used in release view) is not going to be broken for GHES users, but I need to make sure we're handling that case correctly. I mean, GHES API will not include the immutable field in the response, so gh will see it populated with the zero value for bool types, which is false in Go. Is that a correct assumption that a the release is mutable? Basically, I'm asking what's the default value for the immutable field at the server side.

bdehamer · 2025-07-10T14:32:22Z

@babakks

Thanks for catching this. I didn't think through the implications for GHES with this change.

By default, all releases are mutable (immutable == false) so the absence of that particular field in the REST response should result in correct behavior.

Would it make sense for me to split this PR into two: one for the release view change and one for the release list change? We could include the view change now and hold the list update until we have proper support in GHES.

TBH, I care more about having this data available in release view -- I updated release list just for sake of completeness/parity.

babakks · 2025-07-10T16:45:48Z

TBH, I care more about having this data available in release view -- I updated release list just for sake of completeness/parity.

That's fair. As I discussed this with @williammartin, we want to move forward with your suggestion. However, may I ask you to create another issue for adding the isImmutable field to release list? We need it to be there on our backlog and also for our community to vote on it.

Sorry, due to the GHES support stuff, I didn't go through a proper review of your PR. I'll review it and let you know if it needs any changes.

Signed-off-by: Brian DeHamer <bdehamer@github.com>

bdehamer · 2025-07-10T18:52:21Z

@babakks I've pared this PR down to just include the changes to the release view command.

I've opened a separate issue for the change to release list which we can handle separately: #11272

babakks

Thanks again for the PR, @bdehamer!

The changes looks good, except a breaking change to the machine-readable output. I've explain in a comment below.

Now, we have two options I think:

Leave the machine-readable release view output as it was (i.e. not showing isImmutable) and only provide isImmutable in the JSON output, which is not a breaking change at all. In that case, once you fix my comment below we're good to go and merge the PR.
If you insist on surfacing isImmutable field on the machine-readable output, probably with good reasons, I'd need to consult with other folks to see what's their experience in such cases.

Let me know which works for you, and we can pick it up from there.

pkg/cmd/release/view/view.go

pkg/cmd/release/view/view_test.go

andyfeller

LGTM

babakks

Ship it! 🍻

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.74.2` -> `v2.76.1` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>cli/cli (cli/cli)</summary> ### [`v2.76.1`](https://github.com/cli/cli/releases/tag/v2.76.1): GitHub CLI 2.76.1 [Compare Source](cli/cli@v2.76.0...v2.76.1) #### `gh pr create` regression fix This release fixes a regression introduced in `v2.76.0` where organization teams were retrieved outside of intentional use cases. This caused problems for GitHub Enterprise Server users using the GitHub Actions automatic token that does not have access to organization teams. For more information, see cli/cli#11360 #### What's Changed ##### 🐛 Fixes - Fix: `gh pr create`, only fetch teams when reviewers contain a team by [@BagToad](https://github.com/BagToad) in cli/cli#11361 ##### 📚 Docs & Chores - add tenancy aware for san matcher by [@ejahnGithub](https://github.com/ejahnGithub) in cli/cli#11261 - Run Lint and Tests on `push` to `trunk` branch by [@andyfeller](https://github.com/andyfeller) in cli/cli#11325 - update ownership of pkg/cmd/release/shared/ by [@ejahnGithub](https://github.com/ejahnGithub) in cli/cli#11326 - Automate spam issue detection by [@babakks](https://github.com/babakks) in cli/cli#11316 - Improve `api` `--preview` docs by [@jsoref](https://github.com/jsoref) in cli/cli#11274 - Incorporate govulncheck into workflows by [@andyfeller](https://github.com/andyfeller) in cli/cli#11332 - chore(deps): bump advanced-security/filter-sarif from 1.0.0 to 1.0.1 by [@dependabot](https://github.com/dependabot)\[bot] in cli/cli#11298 - chore(deps): bump github.com/sigstore/sigstore-go from 1.0.0 to 1.1.0 by [@dependabot](https://github.com/dependabot)\[bot] in cli/cli#11307 **Full Changelog**: cli/cli@v2.76.0...v2.76.1 ### [`v2.76.0`](https://github.com/cli/cli/releases/tag/v2.76.0): GitHub CLI 2.76.0 [Compare Source](cli/cli@v2.75.1...v2.76.0) ####

Copilot Coding Agent Support GitHub Copilot Pro+ and Copilot Enterprise subscribers can now assign issues to GitHub Copilot during issue creation using: - Command-line flag: `gh issue create --assignee @copilot` - Launching web browser: `gh issue create --assignee @copilot --web` - Or interactively selecting `Copilot (AI)` as assignee in `gh issue create` metadata For more details, refer to [the full changelog post for Copilot coding agent](https://github.blog/changelog/2025-05-19-github-copilot-coding-agent-in-public-preview/). #### What's Changed ##### ✨ Features - Assign Copilot during `gh issue create` by [@andyfeller](https://github.com/andyfeller) in cli/cli#11279 - Display immutable field in `release view` command by [@bdehamer](https://github.com/bdehamer) in cli/cli#11251 ##### 🐛 Fixes - FIX: Do not fetch logs for skipped jobs by [@babakks](https://github.com/babakks) in cli/cli#11312 - Transform `extension` and `filename` qualifiers into `path` qualifier for web code search by [@samcoe](https://github.com/samcoe) in cli/cli#11211 ##### 📚 Docs & Chores - FIX: Workflow does not contain permissions by [@BagToad](https://github.com/BagToad) in cli/cli#11322 - Add automated feature request response workflow by [@BagToad](https://github.com/BagToad) in cli/cli#11299 **Full Changelog**: cli/cli@v2.75.1...v2.76.0 ### [`v2.75.1`](https://github.com/cli/cli/releases/tag/v2.75.1): GitHub CLI 2.75.1 [Compare Source](cli/cli@v2.75.0...v2.75.1) #### What's Changed ##### 🐛 Fixes - Ensure hostnames are visible in CLI website by [@andyfeller](https://github.com/andyfeller) in cli/cli#11295 - Revert "Fix: `gh pr create` prioritize `--title` and `--body` over `--fill` when `--web` is present" by [@andyfeller](https://github.com/andyfeller) in cli/cli#11300 ##### 📚 Docs & Chores - Ensure go directive is always .0 version in bump by [@williammartin](https://github.com/williammartin) in cli/cli#11259 - Minor (1-word) documentation typo in generated `~/.config/gh/config.yml` by [@kurahaupo](https://github.com/kurahaupo) in cli/cli#11246 - Automate closing of stale issues by [@babakks](https://github.com/babakks) in cli/cli#11268 - Filter the `third-party/` folder out of CodeQL results by [@BagToad](https://github.com/BagToad) in cli/cli#11278 - Exclude `third-party` source from golangci-lint by [@andyfeller](https://github.com/andyfeller) in cli/cli#11293 #####

Dependencies - Bump Go to 1.24.5 by [@github-actions](https://github.com/github-actions)\[bot] in cli/cli#11255 - chore(deps): bump github.com/sigstore/protobuf-specs from 0.4.3 to 0.5.0 by [@dependabot](https://github.com/dependabot)\[bot] in cli/cli#11263 - chore(deps): bump golang.org/x/term from 0.32.0 to 0.33.0 by [@dependabot](https://github.com/dependabot)\[bot] in cli/cli#11266 - chore(deps): bump golang.org/x/sync from 0.15.0 to 0.16.0 by [@dependabot](https://github.com/dependabot)\[bot] in cli/cli#11264 - chore(deps): bump golang.org/x/text from 0.26.0 to 0.27.0 by [@dependabot](https://github.com/dependabot)\[bot] in cli/cli#11265 - chore(deps): bump golang.org/x/crypto from 0.39.0 to 0.40.0 by [@dependabot](https://github.com/dependabot)\[bot] in cli/cli#11275 #### New Contributors - [@kurahaupo](https://github.com/kurahaupo) made their first contribution in cli/cli#11246 - [@github-actions](https://github.com/github-actions)\[bot] made their first contribution in cli/cli#11255 **Full Changelog**: cli/cli@v2.75.0...v2.75.1 ### [`v2.75.0`](https://github.com/cli/cli/releases/tag/v2.75.0): GitHub CLI 2.75.0 [Compare Source](cli/cli@v2.74.2...v2.75.0) #### What's Changed ##### ✨ Features - init release verify subcommands by [@ejahnGithub](https://github.com/ejahnGithub) in cli/cli#11018 - Embed Windows resources (VERSIONINFO) during build by [@babakks](https://github.com/babakks) in cli/cli#11048 - Support `--no-repos-selected` on `gh secret set` by [@williammartin](https://github.com/williammartin) in cli/cli#11217 ##### 🐛 Fixes - Fix: `gh pr create` prioritize `--title` and `--body` over `--fill` when `--web` is present by [@dankrzeminski32](https://github.com/dankrzeminski32) in cli/cli#10547 - fix: get token for active user instead of blank if possible by [@anuraaga](https://github.com/anuraaga) in cli/cli#11038 - Use Actions API to retrieve job run logs as a fallback mechanism by [@babakks](https://github.com/babakks) in cli/cli#11172 - Fix query object state mutation during pagination by [@babakks](https://github.com/babakks) in cli/cli#11244 - Handle `HTTP 404` when deleting remote branch in `pr merge` by [@babakks](https://github.com/babakks) in cli/cli#11234 ##### 📚 Docs & Chores - chore: fix function name by [@jinjingroad](https://github.com/jinjingroad) in cli/cli#11149 - chore: update Go version to 1.24 in devcontainer configuration and docs by [@tMinamiii](https://github.com/tMinamiii) in cli/cli#11158 - Ensure lint workflow checks whether 3rd party license and code is up to date by [@andyfeller](https://github.com/andyfeller) in cli/cli#11047 - docs: install\_linux.md: add Solus linux install instructions by [@chax](https://github.com/chax) in cli/cli#10823 - Fix missing newline in install\_linux.md by [@BagToad](https://github.com/BagToad) in cli/cli#11160 - Ensure automation uses pinned go-licenses version by [@andyfeller](https://github.com/andyfeller) in cli/cli#11161 - Add `workflow_dispatch` support to MR Help Wanted check by [@BagToad](https://github.com/BagToad) in cli/cli#11179 - Remove unused `GH_TOKEN` env variable from workflow by [@BagToad](https://github.com/BagToad) in cli/cli#11190 - Add workflow to automate go version bumping by [@williammartin](https://github.com/williammartin) in cli/cli#11189 - Fix inconsistent use of tabs and spaces by [@Stefan-Heimersheim](https://github.com/Stefan-Heimersheim) in cli/cli#11194 - Decouple arg parsing from MR finder by [@babakks](https://github.com/babakks) in cli/cli#11192 - docs: consistently use `apt` in installation instructions by [@tklauser](https://github.com/tklauser) in cli/cli#11216 - Ensure bump go script has git user configured by [@williammartin](https://github.com/williammartin) in cli/cli#11229 - Inject token into bump-go workflow by [@williammartin](https://github.com/williammartin) in cli/cli#11233 - Reinstating Primer Style CLI content within `cli/cli` repository by [@andyfeller](https://github.com/andyfeller) in cli/cli#11060 - Add setup-go to bump-go workflow by [@williammartin](https://github.com/williammartin) in cli/cli#11237 - Ensure GoReleaser does not break on Mac OS and Linux when skipping Windows `.rsyso` generation script by [@andyfeller](https://github.com/andyfeller) in cli/cli#11257 #####

Dependencies - Bump all dependencies except dev-tunnels by [@williammartin](https://github.com/williammartin) in cli/cli#11203 - Update microsoft dev-tunnels to v0.1.13 by [@williammartin](https://github.com/williammartin) in cli/cli#11205 - Consume dependabot minor versions for go modules by [@williammartin](https://github.com/williammartin) in cli/cli#11213 #### New Contributors - [@jinjingroad](https://github.com/jinjingroad) made their first contribution in cli/cli#11149 - [@tMinamiii](https://github.com/tMinamiii) made their first contribution in cli/cli#11158 - [@chax](https://github.com/chax) made their first contribution in cli/cli#10823 - [@dankrzeminski32](https://github.com/dankrzeminski32) made their first contribution in cli/cli#10547 - [@anuraaga](https://github.com/anuraaga) made their first contribution in cli/cli#11038 - [@Stefan-Heimersheim](https://github.com/Stefan-Heimersheim) made their first contribution in cli/cli#11194 **Full Changelog**: cli/cli@v2.74.2...v2.75.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Copilot AI review requested due to automatic review settings July 8, 2025 16:38

bdehamer requested a review from a team as a code owner July 8, 2025 16:38

bdehamer requested a review from BagToad July 8, 2025 16:38

bdehamer temporarily deployed to cli-automation July 8, 2025 16:38 — with GitHub Actions Inactive

cliAutomation added the external pull request originating outside of the CLI core team label Jul 8, 2025

Copilot AI reviewed Jul 8, 2025

View reviewed changes

pkg/cmd/release/list/http.go Outdated Show resolved Hide resolved

ejahnGithub approved these changes Jul 9, 2025

View reviewed changes

babakks requested changes Jul 10, 2025

View reviewed changes

babakks requested review from babakks and removed request for BagToad July 10, 2025 16:46

include immutable field in release view

c335c5e

Signed-off-by: Brian DeHamer <bdehamer@github.com>

bdehamer force-pushed the bdehamer/immutable-release-field branch from 0c89706 to c335c5e Compare July 10, 2025 18:47

bdehamer changed the title ~~Display immutable field for releases~~ Display immutable field in release view command Jul 10, 2025

andyfeller mentioned this pull request Jul 11, 2025

Include isImmutable in release list #11272

Open

babakks reviewed Jul 17, 2025

View reviewed changes

pkg/cmd/release/view/view.go Show resolved Hide resolved

pkg/cmd/release/view/view_test.go Show resolved Hide resolved

bdehamer force-pushed the bdehamer/immutable-release-field branch from 4df87e8 to c335c5e Compare July 17, 2025 14:29

andyfeller approved these changes Jul 17, 2025

View reviewed changes

andyfeller enabled auto-merge July 17, 2025 14:34

andyfeller requested a review from babakks July 17, 2025 14:34

andyfeller disabled auto-merge July 17, 2025 14:45

babakks approved these changes Jul 17, 2025

View reviewed changes

andyfeller merged commit 47f24b9 into trunk Jul 17, 2025
32 checks passed

andyfeller deleted the bdehamer/immutable-release-field branch July 17, 2025 14:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Display immutable field in `release view` command #11251

Display immutable field in `release view` command #11251

Uh oh!

bdehamer commented Jul 8, 2025 •

edited

Loading

Uh oh!

cliAutomation commented Jul 8, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

babakks left a comment •

edited

Loading

Uh oh!

bdehamer commented Jul 10, 2025

Uh oh!

babakks commented Jul 10, 2025

Uh oh!

bdehamer commented Jul 10, 2025

Uh oh!

babakks left a comment

Uh oh!

Uh oh!

Uh oh!

andyfeller left a comment

Uh oh!

babakks left a comment

Uh oh!

Uh oh!

Uh oh!

Display immutable field in release view command #11251

Display immutable field in release view command #11251

Uh oh!

Conversation

bdehamer commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cliAutomation commented Jul 8, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

babakks left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bdehamer commented Jul 10, 2025

Uh oh!

babakks commented Jul 10, 2025

Uh oh!

bdehamer commented Jul 10, 2025

Uh oh!

babakks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

andyfeller left a comment

Choose a reason for hiding this comment

Uh oh!

babakks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Display immutable field in `release view` command #11251

Display immutable field in `release view` command #11251

bdehamer commented Jul 8, 2025 •

edited

Loading

babakks left a comment •

edited

Loading