Skip to content
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

Formulate plan given AlecAivazis/survey going unmaintained #8084

Open
andyfeller opened this issue Sep 25, 2023 · 8 comments
Open

Formulate plan given AlecAivazis/survey going unmaintained #8084

andyfeller opened this issue Sep 25, 2023 · 8 comments
Labels
core This issue is not accepting PRs from outside contributors tech-debt A chore that addresses technical debt

Comments

@andyfeller
Copy link
Contributor

andyfeller commented Sep 25, 2023

Overview

The GitHub CLI has depended upon https://github.com/AlecAivazis/survey for defining our prompting experience, however we will need to begin looking to the future as the primary maintainer is unable to continue supporting this effort. The repository was marked read-only on September 23rd 2023 and becomes an unmaintained dependency.

Firstly, a big warm thank you to @AlecAivazis for devoting so much time and energy to a project that has benefited others! ❤ 🤗 We would like to wish you only the best.

Secondly, this issue is to understand the other options available for managing the GitHub CLI prompting experience. The AlecAivazis/survey project suggests consideration of https://github.com/charmbracelet/bubbletea, however it is unclear how well the project fits and how much effort is involved in switching. As a team of 3 engineers currently, it is unrealistic that we would be able to adopt and support the project ourselves.

@cliAutomation cliAutomation added the needs-triage needs to be reviewed label Sep 25, 2023
@andyfeller andyfeller added tech-debt A chore that addresses technical debt and removed needs-triage needs to be reviewed labels Sep 25, 2023
@AlecAivazis
Copy link

AlecAivazis commented Sep 25, 2023

Thanks for the ping here! If there is someone on the cli team that wants to take ownership, I would more than gladly hand over the repository - just let me know who/what org!

@maaslalani
Copy link

Hi! I’m from the Charm team and one of the Bubble Tea maintainers. Would you be interested in some assistance with this? We believe we can produce and maintain something sustainable that will suit your needs here.

@williammartin
Copy link
Member

Hi @AlecAivazis, thanks for the offer. Right now we don't think that we'd be best positioned to take ownership of the project as we don't have the capacity to support it properly, and wouldn't want to give that impression to the community. If that changes, we'll definitely reach out to you.

@maaslalani, we would be interested in chatting with you about this. I think some members of the team past and present have evaluated BubbleTea for our uses before with limited success but we think that since we have your ear as a maintainer, and you've generously offered some time, that it's definitely worth having a discussion. How would be best to proceed on your end?

@maaslalani
Copy link

Awesome @williammartin! How about if we hop on a call to chat through it quickly? My email is maas@charm.sh.

@samcoe samcoe added the core This issue is not accepting PRs from outside contributors label Oct 9, 2023
@tetienne
Copy link

Any news about this? https://github.com/charmbracelet/huh has been released since.

@williammartin
Copy link
Member

No news @tetienne, we worked together with the Charm folks testing huh out with gh and providing feedback but actually doing a move over is a large chunk of work. It's definitely something we're still interested in. Is there a reason that you're interested in this beyond curiosity?

@tetienne
Copy link

tetienne commented Apr 2, 2024

@williammartin Sorry for the delay. Well, I’m often looking at this project to get idea on my own projects. So, I’m really curious what would be your survey lib replacement. And huh looks like pretty nice, but with obviously small caveat due to this young age :)

@williammartin
Copy link
Member

williammartin commented Apr 2, 2024

Hey @tetienne, we're still interested in huh. When working with the folks from charm we integrated it with gh in order to give feedback and we liked it. It's just a big piece of work to swap it out, both from an engineering perspective but also for the change that our users will see, and so we haven't prioritised it yet. We are in the process of going through an accessibility audit for gh, which may help motivate moving.

huh is young as you say, but the folks from charm have a lot of experience delivering terminal packages, and they have funding to continue maintaining it.

andyfeller added a commit to cli/go-gh that referenced this issue Jun 3, 2024
Relates cli/cli#8084
Relates #164

With go-survey/survey being unmaintained, this is an initial prototype of using
https://github.com/charmbracelet/huh as an optional prompting experience
including support for accessiblity needs.

Additionally, this commit includes a simple example to demo the existing and
new experiences in `examples/prompter/main.go`:

- by default, the existing go-survey/survey experience
- specifying `GH_PROMPTER=accessible`, the new charmbracelet/huh experience in rich mode
- specifying `ACCESSIBLE=1` with `GH_PROMPTER=accessible`, the new charmbracelet/huh experience in accessible mode
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core This issue is not accepting PRs from outside contributors tech-debt A chore that addresses technical debt
Projects
None yet
Development

No branches or pull requests

7 participants