Action
/
conventional-changelog-action
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: improved github permissions docs

releases/v3
Michael Bianco 2023-07-04 11:44:40 -06:00
parent 9962c3267b
commit 271d0f7c49
No known key found for this signature in database
GPG Key ID: E5E32D3B0D0B4261
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
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