search

restyled-io / actions

Actions for installing and running Restyled
GNU Affero General Public License v3.0
4 stars 0 forks source link

Enhancement: Information regarding workflow permissions #32

Closed kiyarose closed 2 months ago

kiyarose commented 2 months ago

Proposal to add more information to the readme regarding the action requiring permission to create pull requests. Since the Restyled Action requires the create pull request permission (present in the repository settings), this adds it to the readme to enhance documentation.

This PR adds aforementioned information in the form of a short tip.

pbrisbin commented 2 months ago

Thanks very much!

I'm happy to merge as is, but I have two ideas I wonder what you think:

  1. Should we explain a little that the permissions are only required if you use the create-pull-request action? That is what the examples show, but it's not the only thing you can do.
  2. Should we link to docs on both the setting you mentioned and the permissions key in workflows? Even I don't know how the two interact to be honest.
kiyarose commented 2 months ago
  1. Should we explain a little that the permissions are only required if you use the create-pull-request action? That is what the examples show, but it's not the only thing you can do.

That's a good idea, I can go ahead and change the wording to better fit the extensibility of the action

  1. Should we link to docs on both the setting you mentioned and the permissions key in workflows? Even I don't know how the two interact to be honest.

The page regarding GITHUB_TOKEN permissions (this) could be linked (masked?), as that is what GitHub links on the settings page for Workflow Permissions. Or is there better reading you had in mind?

pbrisbin commented 2 months ago

Looks great, thanks!