Skip to content

Commit 77a8952

Browse files
authored
Merge pull request #221 from iloveitaly/improved-permission-docs
docs: improved github permissions docs
2 parents 9962c32 + 271d0f7 commit 77a8952

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,19 @@ Make sure to install all required packages in the workflow before executing this
114114
Uses all the defaults
115115

116116
```yaml
117+
permissions:
118+
contents: write
119+
117120
- name: Conventional Changelog Action
118121
uses: TriPSs/conventional-changelog-action@v3
119122
with:
120123
github-token: ${{ secrets.github_token }}
121124
```
122125
126+
Write permissions are required in order to enable `git push` when a new version is generated. In some configurations, the
127+
default `secrets.github_token` may not have the correct permissions. You can check your default permissions by looking at
128+
"Set up job" section of your GitHub action run log.
129+
123130
Overwrite everything
124131

125132
```yaml

0 commit comments

Comments
 (0)