Add a troubleshooting guide

[pandafy]

Add which permissions are needed to be selected while creating personal access token.

[alex-page]

Hey @pandafy great idea. Did you want to contribute some documentation in the README.md?

[pandafy]

I would love to but I don't have any idea which permissions are needed to be selected.
We can add troubleshooting guides for :

• Bad credentials
• Can't read repository null (I didn't gave access to privare repository, but it solved after giving this access)
• Access to public repository is must to maintain project board.

[alex-page]

These are the project board scenarios I know. I need to figure out the exact different permissions for each. I have put down some assumptions for permissions.

repo Full control of private repositories

• Public repository and project board
• Private repository and project board

admin:org Full control of orgs and teams, read and write org projects

• Organisation project board
• Organisation public repository with project board
• Organisation private project board
• Organisation with private repository and project board

? Not sure on this one

• User account has a project board
• User account has a private project board

Where to add secrets? organisation or repository.

[pandafy]

repo Full control of private repositories

• Public repository and project board
• Private repository and project board

I didn't need to give full control of private repositories for a public repository I used this with. We should encourage users to follow concept of Least Privilege Permissions.

[alex-page]

Definitely agree on least permissions. I think for next steps we need to do a manual test with each scenario and minimal permissions to make sure they are correct.

I'm happy to do it but I have some other priorities this week.

[alex-page]

Another state to document was found by @canarro #39 (comment)

[pandafy]

I'll will try to do manual testing of required permissions over the weekend. 😄

[pandafy]

There is one more thing which should be added in the documentation, Contributing Guidelines. @alex-page I don't think you ever expected people to contribute to your work. 😆
#40

[rodrigondec]

@alex-page

It will be good to document this too: actions/toolkit#465 (comment).

from #39

[alex-page]

I feel like I should handle an error if the secret is an empty string? What do you think @rodrigondec ?

[rodrigondec]

I feel like I should handle an error if the secret is an empty string? What do you think @rodrigondec ?

I think it is the best case. And add to the docs about this limitation (of the github itself) with references.

@alex-page will you reopen the #39 and make this modification? @conarro just commented on the issue about hist problem. Maybe it's the same?

I can help with the docs 😁

[alex-page]

Yeah i will re-open #39 and we can resolve it with this guide. That would be great @rodrigondec.

@pandafy if you have anything you can put up in a draft PR that would be awesome. Otherwise happy to start a PR we can collaborate on together.

[pandafy]

Apologies @alex-page , I have been busy lately. Please go ahead to create a PR. I will try to give my inputs along the way. 😅