Added GH Token Auth to Readme #68
Conversation
README.md
Outdated
| If you have the [GitHub CLI](https://cli.github.com/) installed, you can use | ||
|
|
||
| ```bash | ||
| export GITHUB_TOKEN="$(gh auth token)" gama | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Thank you for your contribution 🍀
I have a few suggestions:
The use of export isn't necessary if the goal is to run GAMA immediately with the environment variable. Therefore, this line should be modified to:
GITHUB_TOKEN="$(gh auth token)" gamaAlternatively, if users prefer exporting the variable separately, they can use:
export GITHUB_TOKEN="$(gh auth token)"
gamaPersonally, I think the first approach is more concise and effective for instant execution.
Additionally, as mentioned on line 20, we instruct users to create a token. However, with your method, there's no need to create a new token if they have GitHub CLI installed. Could you please add a note explaining that if users have GitHub CLI, they can use their existing token without creating a new one? This would enhance clarity for anyone setting up the tool.
Thank you again for your valuable contribution! 🛸
There was a problem hiding this comment.
Dang that was one of the most polite comments I've read in the last week!
There was a problem hiding this comment.
Just re-read that, yeah, no need for the export if it's not in shell bootstrap a-la .zshrc.
I think somthing like GITHUB_TOKEN="$(gh auth token)" gama should be fine.
There was a problem hiding this comment.
I added some notes, plus I found a bug 😓 it only worked reliably for me when I made a token on the site.
There was a problem hiding this comment.
│ You have exceeded a secondary rate limit. Please wait a few minutes before you try again. If you reach out to GitHub Support for help, please include the request ID │
│ FCFC:236109:869F6B5:1025D3F6:66D7E8B7.]: Repositories cannot be listed
There was a problem hiding this comment.
Hi, actually it's not a bug. GitHub have rate limits for tokens. You can get this error even if you generate a token. 🍀
I think this PR ready to merge after remove this line:
**NOTE: You may still need to generate a token via the GUI if you run into errors**
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [termkit/gama](https://github.com/termkit/gama) | minor | `v1.1.4` -> `v1.2.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>termkit/gama (termkit/gama)</summary> ### [`v1.2.0`](https://github.com/termkit/gama/releases/tag/v1.2.0) [Compare Source](termkit/gama@v1.1.4...v1.2.0) #### What's Changed - Fix "toolchain not available" error when `make build` by [@​VeyronSakai](https://github.com/VeyronSakai) in termkit/gama#55 - General Improvement by [@​canack](https://github.com/canack) in termkit/gama#57 - \[Fix] Documentation Lint by [@​VILJkid](https://github.com/VILJkid) in termkit/gama#59 - \[Fix] Code Cleanup by [@​VILJkid](https://github.com/VILJkid) in termkit/gama#60 - Feature [#​47](termkit/gama#47) : Fill workflow with empty message if no workflow inputs by [@​canack](https://github.com/canack) in termkit/gama#62 - Added GH Token Auth to Readme by [@​Jelloeater](https://github.com/Jelloeater) in termkit/gama#68 - Update README.md with notes for better GITHUB_TOKEN handling by [@​pirafrank](https://github.com/pirafrank) in termkit/gama#69 - Refactor: Live Mode and General Improvements by [@​canack](https://github.com/canack) in termkit/gama#65 #### New Contributors - [@​VeyronSakai](https://github.com/VeyronSakai) made their first contribution in termkit/gama#55 - [@​VILJkid](https://github.com/VILJkid) made their first contribution in termkit/gama#59 - [@​Jelloeater](https://github.com/Jelloeater) made their first contribution in termkit/gama#68 - [@​pirafrank](https://github.com/pirafrank) made their first contribution in termkit/gama#69 **Full Changelog**: termkit/gama@v1.1.4...v1.2.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:eyJjcmVhdGVkSW5WZXIiOiIzOS45MS4yIiwidXBkYXRlZEluVmVyIjoiMzkuOTEuMiIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90Il19-->
No description provided.