Compare commits

..

3 Commits

Author SHA1 Message Date
Stefan Zweifel
22fccc0369
Merge 7f171889c8 into 050015d406 2024-10-08 17:24:12 +01:00
Stefan Zweifel
050015d406
Add Scope/Permissions documentation for PATs
Closes #347
2024-10-06 10:39:09 +02:00
scarf
573710f3d0
docs(README): fix broken protected branch docs link (#346) 2024-10-04 08:56:00 +02:00

View File

@ -224,7 +224,8 @@ storing the token as a secret in your repository and then passing the new token
token: ${{ secrets.PAT }}
```
If you create a personal access token, apply the `repo` and `workflow` scopes.
If you create a personal access token (classic), apply the `repo` and `workflow` scopes.
If you create a fine-grained personal access token, apply the `Contents`-permissions.
If you work in an organization and don't want to create a PAT from your personal account, we recommend using a [robot account](https://docs.github.com/en/github/getting-started-with-github/types-of-github-accounts) for the token.
@ -433,11 +434,14 @@ See [#322](https://github.com/stefanzweifel/git-auto-commit-action/issues/322) f
### Push to protected branches
If your repository uses [protected branches](https://help.github.com/en/github/administering-a-repository/configuring-protected-branches) you have to make some changes to your Workflow for the Action to work properly: You need a Personal Access Token and you either have to allow force pushes or the Personal Access Token needs to belong to an Administrator.
If your repository uses [protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) you have to make some changes to your Workflow for the Action to work properly: You need a Personal Access Token and you either have to allow force pushes or the Personal Access Token needs to belong to an Administrator.
First, you have to create a new [Personal Access Token (PAT)](https://github.com/settings/tokens/new),
store the token as a secret in your repository and pass the new token to the [`actions/checkout`](https://github.com/actions/checkout#usage) Action step.
If you create a personal access token (classic), apply the `repo` and `workflow` scopes.
If you create a fine-grained personal access token, apply the `Contents`-permissions.
```yaml
- uses: actions/checkout@v4
with: