gh-action-sigstore-python
gh-action-sigstore-python copied to clipboard
readme: Should the default example have "contents:write" ?
Now that the default is to upload release artifacts, I wonder if we should add contents: write to the main usage example in README (or at least mention this when releases are discussed)?
- 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
Yeah, makes sense to me!
I'd also request that every permission listed has a code comment clearly stating what it's for.
No objection. I'll try and find some time to do this in the coming days, unless someone else wants to do it first 😉