[#1448] Update documentation to remove need for personal access token #1465
Conversation
Currently, users need to specify a personal access token or a deploy key to automate the generation of the RepoSense report. This is an additional step that makes using this repository less user-friendly for new users. Let's update the documentation to remove the need for the user to generate a personal access token, since the GITHUB_TOKEN is automatically used when generating a report in GitHub Actions.
|
Some minor things to note:
|
|
|
||
| <include src="withTravis.md#section-edit-configs" /> | ||
|
|
||
| {{ step(5)}} **View the generated report:** | ||
| {{ step(4)}} **View the generated report:** |
There was a problem hiding this comment.
Not related to this PR but can the image of this step somehow be made a bit more prominent? As of now, it's looking a bit absurd the way it is displayed. Can do it in a different PR.
| 1. Add a new secret with the name `ACCESS_TOKEN` or `DEPLOY_KEY` (depending on your earlier choice) and the value of the token/key you copied earlier.<br> | ||
|  | ||
| 1. Go to the `Actions` page of your fork of the [publish-RepoSense](https://github.com/reposense/publish-RepoSense) repo. | ||
| 1. Click on the green button that says `I understand my workflows, go ahead and enable them` to enable GitHub Actions on your new repository. |
There was a problem hiding this comment.
Can't seem to find this button on any of my repositories. Can show me where it comes and how?
There was a problem hiding this comment.
It needs to be forked to an account that has never forked the publish-RepoSense repository I think. I reproduced the above message by forking the repository to an empty organisational account.
There was a problem hiding this comment.
Is this just for publish-RepoSense first time? Or whenever someone who hasn't enabled GitHub Actions earlier needs to do this for the first time? In my opinion, I think it's the second case. If it is, then maybe better to add the fact that this step needs to be done only if enabling Actions for the first time. If it is not, then LGTM!
There was a problem hiding this comment.
I think it's the first case where you need to enable it for the first time you fork the repository. Also, GitHub only allows for forking a particular repository once per account, so it will refer to the first time that a particular account has forked the repository.
Is it possible to review reposense/publish-RepoSense#9 as well? That should be merged before this PR is merged. |
Associated pull request: reposense/publish-RepoSense#9.
Part of #1448.
This is the button that users have to press to enable GitHub Actions:
