create `gh project` command #7375

mntlty · 2023-04-26T23:15:47Z

Closes #7362

Verified with tests, in the terminal and with a testing script, everything is still working 🤞

Changes from https://github.com/github/gh-projects:

import project as a root cmd
rename from projects to project in examples
use cmd util, especially the native CLI IO packages, rather than the go-gh ones
use CLI browser
add more cmd tests, for flags and required / exclusive arguments

TODO:

Inherit HTTPClient from command Factory
Avoid Survey prompts when stdin or stdout are not a tty
Avoid printing table headers when table output is not a tty
Avoid printing blank values as "-" and use an empty string instead
Avoid using table printer for printing one-line confirmation messages
Avoid using table printer for printing JSON output
Avoid varying the number of table columns depending on input flags to a command
Add support for choosing non-github.com instances with GH_HOST

…nter

pkg/cmd/project/shared/queries/queries.go

mislav

Thanks for the gargantuan effort! This looks great already. My suggestions come down to largely polishing the UI of the final product.

Regarding your questions:

I don't know yet what we can do about the current --format json support re: bringing that in line with how --json flag works in the rest of gh. Reworking the current code to support --json field1,field2 and only conditionally querying those specific fields from the API might be infeasible for now. Let me think about this for a day or two.
The error I get when I hadn't requested the projects OAuth scope is indeed pretty gnarly. I will look on my end at how that can be handled a bit better.

pkg/cmd/project/close/close.go

pkg/cmd/project/copy/copy.go

pkg/cmd/project/item-edit/item_edit.go

pkg/cmd/project/list/list.go

pkg/cmd/project/view/view.go

…_project

This mostly focuses on removing examples that should be self-evident after scanning the generated flags help text.

…lient and Survey

- Avoid printing confirmation messages through tableprinter - Avoid printing header rows when stdout is redirected

MarcPow · 2023-06-01T20:22:28Z

@williammartin / @mislav - What's the status on this PR?

mislav · 2023-06-05T14:15:57Z

@MarcPow Still applying some UI polish and the plan is to be merged to trunk within a week.

mislav

Thanks for the hard work, @mntlty!!

Turki53341

mt

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [aquaproj/aqua-registry](https://togithub.com/aquaproj/aqua-registry) | minor | `v4.20.0` -> `v4.21.1` | | [cli/cli](https://togithub.com/cli/cli) | minor | `v2.30.0` -> `v2.31.0` | | [weaveworks/eksctl](https://togithub.com/weaveworks/eksctl) | minor | `v0.145.0` -> `v0.146.0` | | [zellij-org/zellij](https://togithub.com/zellij-org/zellij) | patch | `v0.37.1` -> `v0.37.2` | --- ### Release Notes <details> <summary>aquaproj/aqua-registry</summary> ### [`v4.21.1`](https://togithub.com/aquaproj/aqua-registry/releases/tag/v4.21.1) [Compare Source](https://togithub.com/aquaproj/aqua-registry/compare/v4.21.0...v4.21.1) [Issues](https://togithub.com/aquaproj/aqua-registry/issues?q=is%3Aissue+milestone%3Av4.21.1) | [Pull Requests](https://togithub.com/aquaproj/aqua-registry/pulls?q=is%3Apr+milestone%3Av4.21.1) | aquaproj/aqua-registry@v4.21.0...v4.21.1 #### Fixes [#13199](https://togithub.com/aquaproj/aqua-registry/issues/13199) kubernetes-sigs/kustomize: Follow up changes of kustomize v5.1.0 - [kubernetes-sigs/kustomize#5220 ### [`v4.21.0`](https://togithub.com/aquaproj/aqua-registry/releases/tag/v4.21.0) [Compare Source](https://togithub.com/aquaproj/aqua-registry/compare/v4.20.0...v4.21.0) [Issues](https://togithub.com/aquaproj/aqua-registry/issues?q=is%3Aissue+milestone%3Av4.21.0) | [Pull Requests](https://togithub.com/aquaproj/aqua-registry/pulls?q=is%3Apr+milestone%3Av4.21.0) | aquaproj/aqua-registry@v4.20.0...v4.21.0 #### 🎉 New Packages [#13173](https://togithub.com/aquaproj/aqua-registry/issues/13173) [assetnote/surf](https://togithub.com/assetnote/surf): Escalate your SSRF vulnerabilities on Modern Cloud Environments. `surf` allows you to filter a list of hosts, returning a list of viable SSRF candidates [#13174](https://togithub.com/aquaproj/aqua-registry/issues/13174) [iyear/tdl](https://togithub.com/iyear/tdl): A Telegram downloader written in Golang [#13172](https://togithub.com/aquaproj/aqua-registry/issues/13172) [nikolaydubina/go-cover-treemap](https://togithub.com/nikolaydubina/go-cover-treemap): Go code coverage to SVG treemap [@iwata](https://togithub.com/iwata) </details> <details> <summary>cli/cli</summary> ### [`v2.31.0`](https://togithub.com/cli/cli/releases/tag/v2.31.0): GitHub CLI 2.31.0 [Compare Source](https://togithub.com/cli/cli/compare/v2.30.0...v2.31.0) #### What's New - New suite of `project` commands for interacting with and manipulating projects. Huge shoutout 🥳 for the time and effort put into this work by [@mntlty](https://togithub.com/mntlty) in [cli/cli#7375 [cli/cli#7578 - New `search code` command by [@joshkraft](https://togithub.com/joshkraft) in [cli/cli#7376 - New `cs view` command by [@dmgardiner25](https://togithub.com/dmgardiner25) in [cli/cli#7496 [cli/cli#7539 #### What's Changed - `api`: output a single JSON array in REST pagination mode by [@mislav](https://togithub.com/mislav) in [cli/cli#7190 - `api`: support array params in GET queries by [@mislav](https://togithub.com/mislav) in [cli/cli#7513 - `api`: force method to uppercase by [@ffalor](https://togithub.com/ffalor) in [cli/cli#7514 - `alias`: Allow aliases to recognize extended commands by [@srz-zumix](https://togithub.com/srz-zumix) in [cli/cli#7523 - `alias import`: Fix `--clobber` flag by [@samcoe](https://togithub.com/samcoe) in [cli/cli#7569 - `run rerun`: Improve docs around `--job` flag by [@williammartin](https://togithub.com/williammartin) in [cli/cli#7527 - `run view`: Support viewing logs for jobs with composite actions by [@williammartin](https://togithub.com/williammartin) in [cli/cli#7526 - `gist edit`: Add selector option to `gist edit` command by [@kousikmitra](https://togithub.com/kousikmitra) in [cli/cli#7537 - `repo clone`: Set upstream remote to track all branches after initial fetch by [@samcoe](https://togithub.com/samcoe) in [cli/cli#7542 - `extension`: Speed up listing extensions by lazy-loading extension information when needed by [@mislav](https://togithub.com/mislav) in [cli/cli#7493 - `auth`: Add timeouts to keyring operations by [@samcoe](https://togithub.com/samcoe) in [cli/cli#7580 - `auth status`: write to stdout on success by [@rajhawaldar](https://togithub.com/rajhawaldar) in [cli/cli#7540 - `completion`: Fix bash completions for extensions and aliases by [@mislav](https://togithub.com/mislav) in [cli/cli#7525 - `issue/pr view`: alphabetically sort labels for `gh pr/issue view` by [@ffalor](https://togithub.com/ffalor) in [cli/cli#7587 - Fix error handling for extension and shell alias commands by [@samcoe](https://togithub.com/samcoe) in [cli/cli#7567 - Fix pkg imported more than once by [@testwill](https://togithub.com/testwill) in [cli/cli#7591 - Refactor a nested if statement by [@yanskun](https://togithub.com/yanskun) in [cli/cli#7596 - Fix a typo by [@lerocknrolla](https://togithub.com/lerocknrolla) in [cli/cli#7557 - Fix flaky test by [@samcoe](https://togithub.com/samcoe) in [cli/cli#7515 - Credential rotations, renames and decouplings from Mislav by [@williammartin](https://togithub.com/williammartin) in [cli/cli#7544 - build(deps): bump github.com/cli/go-gh/v2 from 2.0.0 to 2.0.1 by [@dependabot](https://togithub.com/dependabot) in [cli/cli#7546 - build(deps): bump github.com/AlecAivazis/survey/v2 from 2.3.6 to 2.3.7 by [@dependabot](https://togithub.com/dependabot) in [cli/cli#7576 #### New Contributors - [@srz-zumix](https://togithub.com/srz-zumix) made their first contribution in [cli/cli#7523 - [@lerocknrolla](https://togithub.com/lerocknrolla) made their first contribution in [cli/cli#7557 - [@testwill](https://togithub.com/testwill) made their first contribution in [cli/cli#7591 - [@rajhawaldar](https://togithub.com/rajhawaldar) made their first contribution in [cli/cli#7540 **Full Changelog**: cli/cli@v2.30.0...v2.31.0 </details> <details> <summary>weaveworks/eksctl</summary> ### [`v0.146.0`](https://togithub.com/weaveworks/eksctl/releases/tag/v0.146.0): eksctl 0.146.0 (permalink) [Compare Source](https://togithub.com/weaveworks/eksctl/compare/0.145.0...0.146.0) ### Release v0.146.0 #### 🎯 Improvements - Update vpc-cni to 1.12.6 ([#6692](https://togithub.com/weaveworks/eksctl/issues/6692)) #### 🧰 Maintenance - Bump dependencies ([#6690](https://togithub.com/weaveworks/eksctl/issues/6690)) #### 📝 Documentation - New eksctl channel ([#6697](https://togithub.com/weaveworks/eksctl/issues/6697)) #### Acknowledgments Weaveworks would like to sincerely thank: [@wind0r](https://togithub.com/wind0r) </details> <details> <summary>zellij-org/zellij</summary> ### [`v0.37.2`](https://togithub.com/zellij-org/zellij/releases/tag/v0.37.2) [Compare Source](https://togithub.com/zellij-org/zellij/compare/v0.37.1...v0.37.2) This is a patch release to fix some minor issues in the previous release. #### What's Changed - hotfix: include theme files into binary by [@jaeheonji](https://togithub.com/jaeheonji) in [zellij-org/zellij#2566 - fix(plugins): make hide_self api idempotent by [@imsnif](https://togithub.com/imsnif) in [zellij-org/zellij#2568 **Full Changelog**: zellij-org/zellij@v0.37.1...v0.37.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♄1�7 **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/scottames/dots).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

mntlty added 7 commits April 24, 2023 21:01

copy gh-projects into pkg/cmd/project

4c51ac7

include project cmd in root cmd

a4d2b8a

rename gh projects to gh project in examples

c26cb57

switch cli/go-gh/v2/pkg/tableprinter for cli/cli/v2/internal/tablepri 1�7

bec78f0

…nter

use internal browser

e87360f

test project cmd flags and input values

78f15ed

attempt to fix tests

d8d604f

github-code-scanning bot found potential problems Apr 26, 2023

View reviewed changes

mntlty marked this pull request as ready for review May 8, 2023 17:13

mntlty requested a review from a team as a code owner May 8, 2023 17:13

mntlty requested review from williammartin and removed request for a team May 8, 2023 17:13

cliAutomation added the external pull request originating outside of the CLI core team label May 8, 2023

cliAutomation added this to Needs review 🤔 in The GitHub CLI May 8, 2023

williammartin requested a review from mislav May 8, 2023 18:40

mislav suggested changes May 10, 2023

View reviewed changes

mislav and others added 14 commits May 10, 2023 20:28

Merge remote-tracking branch 'origin/trunk' into mntlty/gh_project

4fc614e

Depend on github.com/cli/shurcooL-graphql

c256e0b

Fix command name alignment in gh project help docs

f48a0d1

replace [number] with [<number>]

bca04ca

Merge branch 'mntlty/gh_project' of github.com:cli/cli into mntlty/gh 1�7

e2c531a

…_project

use cmdutil.MutuallyExclusive

d742d33

whitespace in imports

7fe71b1

lower default limit from 30 to 100

0c9651a

use cmdutil.NewNoResultsError

9e2e8ac

make limit explicit

6c89a5b

use markdown.Render

f484b82

update tests

c9ad582

use cmdutil.StringEnumFlag

417ee11

use cmdutil.FlagErrorf

4dbc017

mislav and others added 9 commits May 23, 2023 13:08

Simplify project command examples

ee65704

This mostly focuses on removing examples that should be self-evident after scanning the generated flags help text.

Restructure projects API client to reduce coupling to api.NewGraphQLC 1�7

e928f2b

…lient and Survey

💅

031565d

WIP remove or improve tableprinter

ad03305

- Avoid printing confirmation messages through tableprinter - Avoid printing header rows when stdout is redirected

replace --owner and --user with a single --login flag

cecb04a

missing env var

0e2d540

Avoid using table printer for printing one-line confirmation messages

dffe316

Avoid Survey prompts when stdin or stdout are not a tty

972eb39

Avoid printing confirmation message when STDOUT is not a TTY

e0b326b

samcoe assigned mislav May 29, 2023

mislav and others added 3 commits May 31, 2023 22:00

Have projects commands inherit the HTTP client from Factory

cf2c95a

use config.io.Out for writing JSON

6530b30

rename --login to --owner

bd557f5

mntlty and others added 4 commits June 5, 2023 08:21

remove description and url from project list output

78ad108

number before title

b9d99e7

do not truncate IDs or Numbers

ec93410

🔥 tableprinter

ba98214

mislav approved these changes Jun 9, 2023

View reviewed changes

The GitHub CLI automation moved this from Needs review 🤔 to Needs to be merged 🎉 Jun 9, 2023

mislav enabled auto-merge (squash) June 9, 2023 16:47

mislav merged commit ad4a489 into trunk Jun 9, 2023
10 checks passed

mislav deleted the mntlty/gh_project branch June 9, 2023 16:57

The GitHub CLI automation moved this from Needs to be merged 🎉 to Pending Release 🥚 Jun 9, 2023

This was referenced Jun 13, 2023

Change output of project commands to only return a URL #7577

Closed

output URL on project commands #7578

Merged

Turki53341 reviewed Jun 16, 2023

View reviewed changes

This comment was marked as spam.

Sign in to view

create `gh project` command #7375

create `gh project` command #7375

mntlty commented Apr 26, 2023 •

edited by mislav

mislav left a comment

MarcPow commented Jun 1, 2023

mislav commented Jun 5, 2023

mislav left a comment

Turki53341 left a comment

This comment was marked as spam.

create gh project command #7375

create gh project command #7375

Conversation

mntlty commented Apr 26, 2023 • edited by mislav

mislav left a comment

Choose a reason for hiding this comment

MarcPow commented Jun 1, 2023

mislav commented Jun 5, 2023

mislav left a comment

Choose a reason for hiding this comment

Turki53341 left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

create `gh project` command #7375

create `gh project` command #7375

mntlty commented Apr 26, 2023 •

edited by mislav