Skip to content

Commit

Permalink
Merge pull request #221 from iloveitaly/improved-permission-docs
Browse files Browse the repository at this point in the history
docs: improved github permissions docs
  • Loading branch information
TriPSs committed Jul 5, 2023
2 parents 9962c32 + 271d0f7 commit 77a8952
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,19 @@ Make sure to install all required packages in the workflow before executing this
Uses all the defaults

```yaml
permissions:
contents: write

- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
with:
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

```yaml
Expand Down

0 comments on commit 77a8952

Please sign in to comment.