From 271d0f7c498524cb70ad2c46da5f21fe910e49ee Mon Sep 17 00:00:00 2001 From: Michael Bianco Date: Tue, 4 Jul 2023 11:44:40 -0600 Subject: [PATCH] docs: improved github permissions docs --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 780a549..71a22e9 100644 --- a/README.md +++ b/README.md @@ -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