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

Add warning about required actions permissions on README.md #402

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

marcalexiei
Copy link

Greetings,
Today I setup changeset action for the first time in one of my repository.
During the process I encountered various errors regarding permissions.

This PR adds a warning before all example workflows mentioning the 2 main methods to provide the action a GITHUB_TOKEN with the correct permissions.

Copy link

changeset-bot bot commented Sep 19, 2024

⚠️ No Changeset found

Latest commit: 0db985f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

@GauBen GauBen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran into this very problem today, it would have been very helpful to have this directly in the readme

Thanks for the documentation @marcalexiei

README.md Outdated Show resolved Hide resolved
@toomuchdesign
Copy link

Just an extra note to specify that the full needed permissions seem to be:

contents: write
pull-requests: write
actions: write

actions seems to be needed in order for the dependency update PR tu run the relevant CI actions. Otherwise CI actions will be created and stay stale.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants