-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Ensure users can see v2 projects when viewing issues and PRs, avoid v1 projects on GHES 3.17 and newer #11514
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.
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
Ensure users can see v2 projects when viewing issues and PRs, avoid v1 projects on GHES 3.17 and newer #11514
Conversation
These changes are demonstrating how `gh` commands that support v1 classic projects can determine if support exists by checking the GHES server version.
…ction' into andyfeller/10716-project-featuredetection-api-version
This change updates the v1 project detection logic to retrieve the API version of GHES host to determine support.
These changes enhance the existing `gh issue view` experience by listing v2 projects in interactive and non-interactive forms. Additionally, the tests have been enhanced to use a more standard `httpStubs` approach from other tests.
…tection-api-version Report that v1 classic projects are detected on GHES 3.16.x or older
…issue-view-v2-projects
…pr-view-v2-projects
Display v2 projects in `gh issue view`
View v2 projects in `gh pr view` output
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Enhances project support by displaying v2 projects in issue and PR views while properly handling v1 project deprecation for GHES 3.17+. This ensures users can see v2 project information and avoids v1 API calls on newer GHES versions.
- Adds v2 project item support to issue and PR view commands
- Updates feature detection to check GHES version for v1 project support cutoff at 3.17
- Modifies tests to properly mock v2 project data
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pkg/cmd/pr/view/view.go | Adds projectItems field and v2 project display logic |
| pkg/cmd/pr/view/view_test.go | Updates test expectations to include v2 projects |
| pkg/cmd/pr/view/fixtures/prViewPreviewWithMetadataByNumber.json | Adds test fixture data for v2 projects |
| pkg/cmd/issue/view/view.go | Adds projectItems field and v2 project display logic |
| pkg/cmd/issue/view/view_test.go | Refactors tests to use mock functions for v2 project data |
| internal/featuredetection/feature_detection.go | Implements GHES version checking for v1 project support |
| internal/featuredetection/feature_detection_test.go | Adds comprehensive tests for version-based feature detection |
| api/queries_projects_v2.go | Adds TotalCount field to v2 project queries |
| api/queries_issue.go | Adds TotalCount field to ProjectItems struct |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
BagToad
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.76.2` -> `v2.78.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.78.0`](https://github.com/cli/cli/releases/tag/v2.78.0): GitHub CLI 2.78.0 [Compare Source](cli/cli@v2.77.0...v2.78.0) #### ℹ️ Note This release was cut primarily to resolve a Linux package distribution issue. We recommend reviewing [the v2.77.0 release notes](https://github.com/cli/cli/releases/tag/v2.77.0) for the complete set of latest features and fixes. #### What's Changed ##### ✨ Features - Add `--force` flag to `gh run cancel` by [@​ankddev](https://github.com/ankddev) in [#​11513](cli/cli#11513) ##### 🐛 Fixes - Fix failing to release Linux packages (affected v2.77.0). See [v2.77.0](https://github.com/cli/cli/releases/tag/v2.77.0) for more information. **Full Changelog**: <cli/cli@v2.77.0...v2.78.0> ### [`v2.77.0`](https://github.com/cli/cli/releases/tag/v2.77.0): GitHub CLI 2.77.0 [Compare Source](cli/cli@v2.76.2...v2.77.0) ####⚠️ Incomplete Release The v2.77.0 release experienced a failure publishing to our official Linux repos. This is resolved in [v2.78.0](https://github.com/cli/cli/releases/tag/v2.78.0), so we recommend using that release instead. #### What's Changed ##### ✨ Features - Report that v1 classic projects are detected on GHES 3.16.x or older by [@​andyfeller](https://github.com/andyfeller) in [#​11491](cli/cli#11491) - Display v2 projects in `gh issue view` by [@​andyfeller](https://github.com/andyfeller) in [#​11496](cli/cli#11496) - View v2 projects in `gh pr view` output by [@​andyfeller](https://github.com/andyfeller) in [#​11497](cli/cli#11497) - Ensure users can see v2 projects when viewing issues and MRs, avoid v1 projects on GHES 3.17 and newer by [@​andyfeller](https://github.com/andyfeller) in [#​11514](cli/cli#11514) ##### 🐛 Fixes - fix error for ErrReleaseNotFound when fetching ref by [@​ejahnGithub](https://github.com/ejahnGithub) in [#​11451](cli/cli#11451) - add test for FetchRefSHA by [@​ejahnGithub](https://github.com/ejahnGithub) in [#​11481](cli/cli#11481) - Fix `gh repo delete --yes` safety issue when no repository argument provided by [@​Copilot](https://github.com/Copilot) in [#​11536](cli/cli#11536) ##### 📚 Docs & Chores - Improve spam detection evals by [@​babakks](https://github.com/babakks) in [#​11419](cli/cli#11419) - Fix `help wanted` label regexp in CI automation by [@​babakks](https://github.com/babakks) in [#​11423](cli/cli#11423) - Update spam detection to comment on and close issue by [@​andyfeller](https://github.com/andyfeller) in [#​11435](cli/cli#11435) - Adding a note to `gh search` docs to explain the usage of `--` to exclude certain results by [@​Sukhpreet-s](https://github.com/Sukhpreet-s) in [#​11162](cli/cli#11162) - Update issue triage guidelines and label usage by [@​BagToad](https://github.com/BagToad) in [#​11454](cli/cli#11454) - Reorganize installation docs by [@​andyfeller](https://github.com/andyfeller) in [#​11473](cli/cli#11473) - Update govulncheck workflow to scan source code by [@​BagToad](https://github.com/BagToad) in [#​11482](cli/cli#11482) - Hidden trusted root flag for release verify by [@​ejahnGithub](https://github.com/ejahnGithub) in [#​11511](cli/cli#11511) #####Dependencies - Regenerate third-party licenses on trunk pushes by [@​andyfeller](https://github.com/andyfeller) in [#​11370](cli/cli#11370) - Update third-party license versions by [@​BagToad](https://github.com/BagToad) in [#​11557](cli/cli#11557) - Bump Go to 1.24.6 by [@​github-actions](https://github.com/github-actions)\[bot] in [#​11467](cli/cli#11467) - chore(deps): bump github.com/spf13/pflag from 1.0.6 to 1.0.7 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​11319](cli/cli#11319) - chore(deps): bump actions/download-artifact from 4 to 5 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​11458](cli/cli#11458) - chore(deps): bump actions/checkout from 4 to 5 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​11490](cli/cli#11490) - chore(deps): bump github.com/yuin/goldmark from 1.7.12 to 1.7.13 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​11368](cli/cli#11368) - Bump google.golang.org/grpc & other required dependencies by [@​BagToad](https://github.com/BagToad) in [#​11510](cli/cli#11510) - chore(deps): bump google.golang.org/grpc from 1.73.0 to 1.74.2 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​11367](cli/cli#11367) - chore(deps): bump github.com/cli/go-gh/v2 from 2.12.1 to 2.12.2 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​11537](cli/cli#11537) - chore(deps): bump github.com/go-viper/mapstructure/v2 from 2.3.0 to 2.4.0 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​11556](cli/cli#11556) #### New Contributors - [@​Sukhpreet-s](https://github.com/Sukhpreet-s) made their first contribution in [#​11162](cli/cli#11162) - [@​Copilot](https://github.com/Copilot) made their first contribution in [#​11536](cli/cli#11536) **Full Changelog**: <cli/cli@v2.76.2...v2.77.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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS44Mi4xIiwidXBkYXRlZEluVmVyIjoiNDEuODIuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90Il19-->
|
SECURITY |
Fixes #10716, #10708, #11409
With v1 classic projects being deprecated, this pull request improves users' v2 projects experience while also ensuring v1 projects functionality works for the correct GHES versions:
gh issue viewwill show information about v2 projects it is contained ongh pr viewwill show information about v2 projects it is contained onghwill avoid retrieving data or making v1 project API calls if GHES version is 3.17 or newerDemo
GitHub.com
Source: Tiny Kanban (view)
Source: tinyfists/gh-nonsense#7
Source: tinyfists/gh-nonsense#8
GHES 3.17
$ gh api /meta --hostname ghe.io { "verifiable_password_authentication": false, "installed_version": "3.17.0" }GHES 3.16