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

Update Readme.md to remove ambiguity for personal token creation #445

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

DhruvAwasthi
Copy link

There has been recent change in the ways to create GitHub API token. Earlier there was only one option to create token but now with the recent change one more option is added i.e. Generate new token (Fine-grained, repo-scoped). The current documentation assumes we are creating a token with earlier option i.e. Generate new token (For general use) and thus says "You'll need a GitHub API Token with repo and user scope...". With the advent of new option this is invalid. Hence we need to specify in the Readme.md file to create the token using previous option only. This commit updates that.

There has been recent change in the ways to create GitHub API token. Earlier there was only one option to create token but now with the recent change one more option is added i.e. Generate new token (Fine-grained, repo-scoped). 
The current documentation assumes we are creating a token with earlier option i.e. Generate new token (For general use) and thus says "You'll need a GitHub API Token with repo and user scope...". With the advent of new option this is invalid. 
Hence we need to specify in the Readme.md file to create the token using previous option only.
This commit updates that.
@pseusys
Copy link
Collaborator

pseusys commented Apr 6, 2023

Can't new tokens be used for action running?

@DhruvAwasthi
Copy link
Author

@pseusys Ofcourse new tokens can be used as well. But they are more fine-grained and we need some additional steps to give them the same permissions as we need to do with the current ones. Giving permission with current ones is as easy as just doing a check box on two permissions but adding permission on new tokens is a bit complicated.
So there are two way - either we mention to go with the usual one or add documentation on how to give permissions on new tokens.

@pseusys
Copy link
Collaborator

pseusys commented Apr 6, 2023

I would suggest updating documentation to cover every possibility, especially the newest features.

@DhruvAwasthi
Copy link
Author

Makes sense. I will update the PR with the proposed changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants