Skip to content

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

Open
marcalexiei wants to merge 1 commit intochangesets:mainfrom
marcalexiei:patch-1
Open

Add warning about required actions permissions on README.md#402
marcalexiei wants to merge 1 commit intochangesets:mainfrom
marcalexiei:patch-1

Conversation

@marcalexiei
Copy link
Copy Markdown

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.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Sep 19, 2024

⚠️ No Changeset found

Latest commit: 27d143e

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
Copy Markdown

@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

@marcalexiei marcalexiei force-pushed the patch-1 branch 2 times, most recently from 4803812 to 0db985f Compare October 8, 2024 05:03
@toomuchdesign
Copy link
Copy Markdown

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.

@MrLightful
Copy link
Copy Markdown

MrLightful commented Feb 15, 2025

Also, having a repo in organization, I had to Allow GitHub Actions to create and approve pull requests (Settings->Actions->General).
But before I could so on repo level, you need to do it on org level first.

There is no appropriate keyword for this in permissions, it needs to be done via UI, right?

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.

4 participants