Merge pull request #221 from iloveitaly/improved-permission-docs

docs: improved github permissions docs
releases/v3
Tycho Bokdam 2023-07-05 09:06:32 +02:00 committed by GitHub
commit 77a8952a0f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions

View File

@ -114,12 +114,19 @@ Make sure to install all required packages in the workflow before executing this
Uses all the defaults Uses all the defaults
```yaml ```yaml
permissions:
contents: write
- name: Conventional Changelog Action - name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3 uses: TriPSs/conventional-changelog-action@v3
with: with:
github-token: ${{ secrets.github_token }} github-token: ${{ secrets.github_token }}
``` ```
Write permissions are required in order to enable `git push` when a new version is generated. In some configurations, the
default `secrets.github_token` may not have the correct permissions. You can check your default permissions by looking at
"Set up job" section of your GitHub action run log.
Overwrite everything Overwrite everything
```yaml ```yaml