docs(readme): update to reflect new token perms

This commit is contained in:
Borja Canseco
2023-01-22 12:28:13 -07:00
parent bdbbe74773
commit 0550b5854e
3 changed files with 14 additions and 0 deletions

BIN
.github/images/token-permissions.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@@ -22,6 +22,8 @@ jobs:
config-file: markdown_link_check_config.json config-file: markdown_link_check_config.json
dogfooding: dogfooding:
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions:
contents: write
steps: steps:
- uses: actions/checkout@master # only required for eating our own dog food - uses: actions/checkout@master # only required for eating our own dog food
- uses: ./ - uses: ./

View File

@@ -57,6 +57,8 @@ on:
jobs: jobs:
single-commit: single-commit:
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions:
contents: write
steps: steps:
- uses: bcanseco/github-contribution-graph-action@v2 - uses: bcanseco/github-contribution-graph-action@v2
env: env:
@@ -78,6 +80,8 @@ on: push
jobs: jobs:
backfill-commits: backfill-commits:
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions:
contents: write
steps: steps:
- uses: bcanseco/github-contribution-graph-action@v2 - uses: bcanseco/github-contribution-graph-action@v2
env: env:
@@ -157,6 +161,14 @@ env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
#### Getting 403 errors? ❌
Make sure your token has [write permission for the `contents` scope](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs). If you're using the examples in this README, this is already done for you.
You can alternatively set this as a repo-level default:
![](./.github/images/token-permissions.png)
### `GIT_EMAIL` 📧 ### `GIT_EMAIL` 📧
This GitHub Action requires an email associated with your GitHub account. If you provide a random or throwaway email, contributions won't show up on your GitHub profile. [Read more](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#you-havent-added-your-local-git-commit-email-to-your-profile). This GitHub Action requires an email associated with your GitHub account. If you provide a random or throwaway email, contributions won't show up on your GitHub profile. [Read more](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#you-havent-added-your-local-git-commit-email-to-your-profile).