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

readme: Should the default example have "contents:write" ? #147

Open
jku opened this issue Jul 9, 2024 · 3 comments
Open

readme: Should the default example have "contents:write" ? #147

jku opened this issue Jul 9, 2024 · 3 comments
Labels
bug Something isn't working enhancement New feature or request

Comments

@jku
Copy link
Member

jku commented Jul 9, 2024

Now that the default is to upload release artifacts, I wonder if we should add contents: write to the main usage example in README?

  • The selftest does not need this permission I believe because the upload only triggers on release events
  • Could add the release trigger to the example as well since it's IMO the most magic in this action (I had never used GitHub release events for doing e.g. pypi releases so it was surprising to see it's required by this action)
  • if we're changing the example, could change the job name as well: "selftest" sounds a little weird in an example
@jku jku added bug Something isn't working enhancement New feature or request labels Jul 9, 2024
@woodruffw
Copy link
Member

Yeah, makes sense to me!

@webknjaz
Copy link

I'd also request that every permission listed has a code comment clearly stating what it's for.

@woodruffw
Copy link
Member

No objection. I'll try and find some time to do this in the coming days, unless someone else wants to do it first 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants