Skip to content

Commit

Permalink
Add warning about required actions permissions on README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marcalexiei authored Sep 19, 2024
1 parent 50750fa commit 15aac6f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,23 @@ This action for [Changesets](https://github.com/atlassian/changesets) creates a

### Example workflow:

> [!WARNING]
>
> Before run one of the following workflows be sure that the `GITHUB_TOKEN` has the permission to access the repository contents and create a PR
> You can do this:
> - [Using repository Action settings](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)
>
> Under "Workflow permissions" section
> - choose "Read and write permissions"
> - enable "Allow GitHub Actions to create and approve pull requests"
>
> - [Using `permissions` key in the workflow file](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#permissions)
> ```yml
> permissions:
> contents: write
> pull-requests: write
> ```
#### Without Publishing
Create a file at `.github/workflows/release.yml` with the following content.
Expand Down

0 comments on commit 15aac6f

Please sign in to comment.