docs: Adjust the PAT and protected branch documentation (#174)

This commit is contained in:
Pascal Zimmermann
2023-12-03 19:58:18 +01:00
committed by GitHub
parent d91a481090
commit c8e9166762
5 changed files with 11 additions and 1 deletions

View File

@ -192,7 +192,7 @@ jobs:
branch: ${{ github.ref }}
```
An example workflow to push to a protected branch inside your own repository. Be aware that it's necessary to use a personal access token, and maybe it is a good idea to specify the force-with-lease flag in case of sync and push errors:
An example workflow to push to a protected branch inside your repository. Be aware that it's necessary to use a personal access token and use it inside the `actions/checkout` action. It may be a good idea to specify the force-with-lease flag in case of sync and push errors. If you want to generate an adequate personal access token, you can [follow](docs/personal-acces-token.md#creation-of-a-personal-access-token) these instructions:
```yaml
jobs:

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@ -0,0 +1,10 @@
# Creation of a personal access token
1. Login to your GitHub account and navigate to the following [page](https://github.com/settings/tokens).
2. Click on the generate new token button and start the process to get a new token (classic or fine-gained)
- In the classic mode your token needs as a minimum requirement for private repositories, complete repo and admin read:org access. ![PAT Private Repo](images/Github_PAT_Private_Repo.jpeg)
- In the classic mode and you want to use it on public repositories, your token needs public_repo access. ![PAT Public Repo](images/Github_PAT_Public_Repo.jpeg)
- If you want to use a fine-gained token as minimum requirement, your token needs access to the repository, contents read/write, metadata read and actions read access. ![PAT Fine Gained](images/Github_PAT_Fine_Gained.jpeg)
3. Be aware, if you want to update GitHub workflow files, it's necessary that your token got workflow rights (read/write on fine-gained tokens).