Skip to content

Commit

Permalink
docs: suggest right permissions for write access (#159)
Browse files Browse the repository at this point in the history
  • Loading branch information
jyasskin committed May 17, 2023
1 parent 0df668f commit 9584000
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ jobs:
main:
name: Build, Validate and Deploy
runs-on: ubuntu-20.04
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: w3c/spec-prod@v2
Expand All @@ -98,6 +100,8 @@ jobs:
main:
name: Deploy to GitHub pages
runs-on: ubuntu-20.04
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: w3c/spec-prod@v2
Expand Down Expand Up @@ -174,6 +178,8 @@ jobs:
main:
name: Build, Validate and Deploy
runs-on: ubuntu-20.04
permissions:
contents: write
strategy:
max-parallel: 1
matrix:
Expand Down Expand Up @@ -220,6 +226,8 @@ jobs:
main:
name: Build, Validate and Deploy
runs-on: ubuntu-20.04
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: w3c/spec-prod@v2
Expand All @@ -243,6 +251,8 @@ jobs:
main:
name: Build, Validate and Deploy
runs-on: ubuntu-20.04
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: w3c/spec-prod@v2
Expand Down
1 change: 1 addition & 0 deletions docs/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ Whether or not to validate markup using the [Nu Html Checker](https://github.com
## `GH_PAGES_BRANCH`

Whether or not to deploy to GitHub pages. Set to a Falsy value to not deploy, or provide a Git branch name to push to. You would need to enable GitHub pages publish source in repository settings manually.
When this option is set, you need to ensure that the `GITHUB_TOKEN` for the job running spec-prod has [`write` access to the `contents` scope](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token).

**Possible values:**: None, or a git branch name.

Expand Down

0 comments on commit 9584000

Please sign in to comment.