Add `isImmutable` to `release list` JSON output #12064

babakks · 2025-10-31T19:54:44Z

Notes for reviewers

Since the GraphQL query has to be different based on the host's support for immutable releases, I had three options for implementation:
1. plain text query compilation (i.e. dynamically adding the immutable field if applicable)
2. dynamic handling of two strongly-typed query types in the same function
3. duplicating the strongly-typed query function into two separate ones
I decided to go with the 3rd option since it's more readable and simpler to cleanup (i.e. by just deleting the duplicated function) while keeping our strongly-typed query approach. The cleanup should happen after all covered GHES versions fully support immutable releases. This decision is based on the assumption that there'll be no new Release-level fields/features like this. I might be wrong, in which case I believe it'd be best to go with the first approach (plain text queries) which will make room for adding more fields as we go. Please comment if that's the case and I'll take care of it. Needless to mention the 2nd option is super complex with basically duplicating everything in a single function; harder to read/maintain and aesthetically unpleasant.
Another assumption here, is that new GHES versions will be shipped with immutable releases. So at some point we can comeback and clean up the dual behaviour and bring the simple code back. As I checked, the latest GHES 3.18 does not support immutable releases. So I guess we should at least wait until 3.18 goes EOL. If this is not the right assumption, please let me know. This'll be another reason for going with plain text queries.

A/C Verification

Given I'm using gh against github.com
When I run gh release list -R OWNER/REPO
Then I see no changes in the output structure

Confirmed. The isImmutable field is only visible in JSON mode.

Given I'm using gh against github.com
When I run gh release list -R OWNER/REPO --json name,isImmutable
Then I see the isImmutable field is correctly assigned

Confirmed: (I enabled immutable releases on this before making the second release)

$ gh release list -R gh-babakks/foo --json name,isImmutable | jq 
[
  {
    "isImmutable": false,
    "name": "title"
  },
  {
    "isImmutable": true,
    "name": "v1.1.2"
  }
]

Given I'm using gh against a GHES host that does not support immutable releases
When I run gh release list -R OWNER/REPO --json name,isImmutable
Then I see the isImmutable field is set to false for all entries

Confirmed by testing against GHES 3.18:

$ GH_HOST=<HOST> gh release list -R gh-babakks/foo --json name,isImmutable | jq
[
  {
    "isImmutable": false,
    "name": "title"
  }
]

Given I'm using gh against a GHES host that supports immutable releases
When I run gh release list -R OWNER/REPO --json name,isImmutable
Then I see the isImmutable field is correctly assigned

Unable to confirm since we yet to have such a GHES version.

Signed-off-by: Babak K. Shandiz <[email protected]>

babakks · 2025-10-31T20:28:49Z

pkg/cmd/release/list/http.go

+func fetchReleases(httpClient *http.Client, repo ghrepo.Interface, limit int, excludeDrafts bool, excludePreReleases bool, order string, releaseFeatures fd.ReleaseFeatures) ([]Release, error) {
+	// TODO: immutableReleaseFullSupport
+	// This is a temporary workaround until all supported GHES versions fully
+	// support immutable releases, which would probably be when GHES 3.18 goes
+	// EOL. At that point we can remove this if statement.
+	//
+	// Note 1: This could be have been done differently by using dual two
+	// separate query types or even using plain text/string queries. But, both
+	// would require us to refactor them back in the future, to the single,
+	// strongly-typed query approach as it was before. So, duplicating the entire
+	// function for now seems like the lesser evil, with a quicker and less risky
+	// clean up in the near future.
+	//
+	// Note 2: We couldn't use GraphQL directives like `@include(condition)` or
+	// `@skip`(condition) here because if the field doesn't exist on the schema
+	// then the whole query would still fail regardless of the condition being
+	// met or not.
+	if !releaseFeatures.ImmutableReleases {
+		return fetchReleasesWithoutImmutableReleases(httpClient, repo, limit, excludeDrafts, excludePreReleases, order)
+	}
+


Explained the rationale here as well.

Copilot

Pull Request Overview

This PR adds support for immutable releases by implementing feature detection to check if the GitHub host supports the immutable field on releases. The implementation includes a temporary workaround for GHES versions that don't support this feature yet.

Key Changes:

Adds ReleaseFeatures detection to identify whether a GitHub host supports immutable releases
Implements dual code paths: one that queries the immutable field and another that doesn't, based on feature detection
Updates tests to cover both supported and unsupported scenarios for immutable releases

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
pkg/cmd/release/list/list.go	Integrates feature detection for immutable releases into the list command
pkg/cmd/release/list/http.go	Adds conditional GraphQL queries based on immutable release support and creates temporary fallback function
pkg/cmd/release/list/list_test.go	Expands test coverage with separate test cases for supported and unsupported immutable releases
internal/featuredetection/feature_detection.go	Implements `ReleaseFeatures()` method to detect immutable release support
internal/featuredetection/feature_detection_test.go	Adds comprehensive tests for release feature detection
internal/featuredetection/detector_mock.go	Adds mock implementations for testing with/without immutable release support

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pkg/cmd/release/list/http.go

pkg/cmd/release/list/list.go

Signed-off-by: Babak K. Shandiz <[email protected]>

bdehamer · 2025-10-31T22:37:15Z

This decision is based on the assumption that there'll be no new Release-level fields/features like this

There are no plans for adding additional fields to the Release object at this time.

Another assumption here, is that new GHES versions will be shipped with immutable releases.

Yes. GHES 3.19 will be the first version which returns the immutable field in the GQL Release object (though it will always be "false"). GHES 3.20 will be the first version in which users can actually enable immutable releases on their repositories..

bdehamer

LGTM!

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.82.1` -> `v2.83.0` | 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.83.0`](https://github.com/cli/cli/releases/tag/v2.83.0): GitHub CLI 2.83.0 [Compare Source](cli/cli@v2.82.1...v2.83.0) #### What's Changed ##### ✨ Features - Add `isImmutable` to `release list` JSON output by [@babakks](https://github.com/babakks) in [#12064](cli/cli#12064) - `gh agent-task create`: support `--custom-agent`/`-a` flag by [@BagToad](https://github.com/BagToad) in [#12068](cli/cli#12068) - 💡 (gh repo delete) Add warning when `--yes` is ignored without a repository, Closes: [#12033](cli/cli#12033) by [@Shion1305](https://github.com/Shion1305) in [#12039](cli/cli#12039) - feat: implement gh `pr revert` by [@lucasmelin](https://github.com/lucasmelin) in [#8826](cli/cli#8826) ##### 🐛 Fixes - fix(gist): add support for editing & viewing large files by [@luxass](https://github.com/luxass) in [#11761](cli/cli#11761) - Fix gh attestation verify to work when Public Good Instance of Sigstore is unavailable by [@Copilot](https://github.com/Copilot) in [#11989](cli/cli#11989) ##### 📚 Docs & Chores - chore: add basic linters by [@babakks](https://github.com/babakks) in [#12084](cli/cli#12084) - CI: Update lint govulncheck to use source mode by [@BagToad](https://github.com/BagToad) in [#12089](cli/cli#12089) - chore: add `workflow_dispatch` to govulncheck triggers by [@babakks](https://github.com/babakks) in [#12085](cli/cli#12085) - Exclude `third-party` from Golangci-lint formatting paths by [@babakks](https://github.com/babakks) in [#12058](cli/cli#12058) - Apply `go fix` to remove deprecated `// +build` tags by [@babakks](https://github.com/babakks) in [#12056](cli/cli#12056) - Bump Golangci-lint to `v2.6.0` by [@babakks](https://github.com/babakks) in [#12049](cli/cli#12049) - Mention `pr checks` in `run list` docs by [@babakks](https://github.com/babakks) in [#12050](cli/cli#12050) - Fix typo in comment for `gh issue develop` branch checkout command by [@jonzfisher](https://github.com/jonzfisher) in [#12042](cli/cli#12042) - Use "release" sentinel value for release attestation verification by [@Copilot](https://github.com/Copilot) in [#11991](cli/cli#11991) - Improve docstring for release-create by [@bdehamer](https://github.com/bdehamer) in [#11945](cli/cli#11945) - Improve `api` command docs around `--input` and `--field` by [@babakks](https://github.com/babakks) in [#12062](cli/cli#12062) - Fix `--interval` flags docs in `gh pr checks` by [@2003Aditya](https://github.com/2003Aditya) in [#12053](cli/cli#12053) #####

Dependencies - Bump Go to 1.25.3 by [@github-actions](https://github.com/github-actions)\[bot] in [#11926](cli/cli#11926) - chore(deps): bump github.com/cli/go-gh/v2 from 2.12.2 to 2.13.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12095](cli/cli#12095) - Update Go toolchain version to 1.24.9 by [@BagToad](https://github.com/BagToad) in [#12054](cli/cli#12054) - chore(deps): bump golang.org/x/text from 0.29.0 to 0.30.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#11973](cli/cli#11973) - chore(deps): bump golang.org/x/crypto from 0.42.0 to 0.43.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#11974](cli/cli#11974) - chore(deps): bump actions/upload-artifact from 4 to 5 by [@dependabot](https://github.com/dependabot)\[bot] in [#12031](cli/cli#12031) - chore(deps): bump actions/download-artifact from 5 to 6 by [@dependabot](https://github.com/dependabot)\[bot] in [#12032](cli/cli#12032) - chore(deps): bump github.com/rivo/tview from 0.0.0-20250625164341-a4a78f1e05cb to 0.42.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12000](cli/cli#12000) - chore(deps): bump goreleaser/goreleaser-action from 6.3.0 to 6.4.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#11509](cli/cli#11509) - chore(deps): bump mislav/bump-homebrew-formula-action from 3.4 to 3.6 by [@dependabot](https://github.com/dependabot)\[bot] in [#11750](cli/cli#11750) #### New Contributors - [@lucasmelin](https://github.com/lucasmelin) made their first contribution in [#8826](cli/cli#8826) - [@jonzfisher](https://github.com/jonzfisher) made their first contribution in [#12042](cli/cli#12042) - [@2003Aditya](https://github.com/2003Aditya) made their first contribution in [#12053](cli/cli#12053) **Full Changelog**: <cli/cli@v2.82.1...v2.83.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).

babakks added 2 commits October 31, 2025 19:52

fix(featuredetection): add ReleaseFeatures method

26552f3

Signed-off-by: Babak K. Shandiz <[email protected]>

feat(release list): add isImmutable JSON field

065fc38

Signed-off-by: Babak K. Shandiz <[email protected]>

babakks linked an issue Oct 31, 2025 that may be closed by this pull request

Include isImmutable in release list #11272

Closed

babakks temporarily deployed to cli-automation October 31, 2025 19:54 — with GitHub Actions Inactive

babakks requested review from a team and BagToad October 31, 2025 20:26

babakks marked this pull request as ready for review October 31, 2025 20:26

babakks requested a review from a team as a code owner October 31, 2025 20:26

Copilot AI review requested due to automatic review settings October 31, 2025 20:26

babakks temporarily deployed to cli-automation October 31, 2025 20:26 — with GitHub Actions Inactive

cliAutomation assigned babakks Oct 31, 2025

babakks requested a review from bdehamer October 31, 2025 20:28

babakks commented Oct 31, 2025

View reviewed changes

Copilot AI reviewed Oct 31, 2025

View reviewed changes

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

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

babakks added 2 commits October 31, 2025 20:36

docs(release list): reword comment

9838926

Signed-off-by: Babak K. Shandiz <[email protected]>

docs(release list): fix typo

9d2bea6

Signed-off-by: Babak K. Shandiz <[email protected]>

bdehamer approved these changes Oct 31, 2025

View reviewed changes

BagToad approved these changes Nov 3, 2025

View reviewed changes

babakks merged commit 895c314 into trunk Nov 4, 2025
11 checks passed

babakks deleted the babakks/add-isimmutable-to-release-list branch November 4, 2025 12:43

babakks mentioned this pull request Nov 5, 2025

Cleanup temporary changes when immutable releases is fully supported #12098

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add `isImmutable` to `release list` JSON output #12064

Add `isImmutable` to `release list` JSON output #12064

babakks commented Oct 31, 2025 •

edited

Loading

Uh oh!

babakks Oct 31, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

bdehamer commented Oct 31, 2025 •

edited

Loading

Uh oh!

bdehamer left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Add isImmutable to release list JSON output #12064

Add isImmutable to release list JSON output #12064

Conversation

babakks commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notes for reviewers

A/C Verification

Uh oh!

babakks Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

bdehamer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Add `isImmutable` to `release list` JSON output #12064

Add `isImmutable` to `release list` JSON output #12064

babakks commented Oct 31, 2025 •

edited

Loading

bdehamer commented Oct 31, 2025 •

edited

Loading