Closed loujaybee closed 1 year ago
I actually got confused and had a Gitpod PAT there the whole time š¤¦. Maybe it's just me being silly, but making this fact more obvious would help as well!
Hey @loujaybee and @filiptronicek, sorry that you had a difficult time setting it up, and thank you so much for the suggestions..these make a ton of sense, we'll make sure to make the respective changes and make things more clear!
Just a small note: This "token" is JUST a temporary fix, we're working on setting up a custom OAuth which eliminates the user to setup anything at all!
Re-posting from a relevant discussion (internal) for visibility:
@gtsiolis: Ah, the extension is working with an access token from GitHub, not from Gitpod. I guess others were also confused by this.
Other issues:
- It also requires a classic token which may not be clear from the instructions or UX.
- You'll still get an error if you only add the minimum repo scopeāthis is also not clear from the instructions.
Install instructions | Scope error |
---|---|
![]() |
![]() |
Hey @gtsiolis, thanks for the quick markup...we tried to specify those scopes but it wasn't possible in Raycast (very less is customisable in this page)
Hence we mentioned the scopes in the installation docs
https://www.raycast.com/henitchobisa/gitpod
While generating the GitHub Access Token, make sure to give the
user
,admin
&repo
access rights, else it may result in some weird behaviours.
How would you suggest adding instructions about the scopes in the "limited" above UI itself?
How would you suggest adding instructions about the scopes in the "limite
@Palanikannan1437 I took a quick look into Raycast's patterns and best practices while developing an extension. Here are some thoughts or potential MVC improvements:
repo
and read:org
scope is required.How would you suggest adding instructions about the scopes in the "limite
@Palanikannan1437 I took a quick look into Raycast's patterns and best practices while developing an extension. Here are some thoughts or potential MVC improvements:
- I'd be specific about the scopes needed.
Going with the hover title seems like a common practiceāthis could be also include the scopes needed. Something like the following could suffice:
- Your GitHub API Token (Classic).
repo
andread:org
scope is required.- I'd rephrase the input label to GitHub API Token (Classic) to make it explicit this is not asking for a token from Gitpod.
- The input placeholder can be simpler, like Enter your GitHub API Token (Classic). Using the (Classic) term in at least the input label or placeholder, if not both, sounds very helpful.
Sure @gtsiolis, will try to work upon these in the upcoming release this week
The input placeholder for the link to GitHub when setting up the extension means I have to re-write or remember the URL it as there's no easy way to copy paste or click the placeholder text. I would suggest:
ghp_huMrY****************************
This is personal preference: I'd remove the text "Before you can start"... etc, as it's implied by the page. Or, consider shortening the copy to be punchier / quicker? If possible could you put the "about this extension" below the input field, also? Feels like a lot of information that I'm required to read before I input the token? (just some other UI clean up thoughts, a little unrelated to the original issue, but thought I'd share if you make a change to that page š !)