Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: suggest right permissions for write access #159

Merged
merged 3 commits into from
May 17, 2023
Merged

docs: suggest right permissions for write access #159

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4378fc
Add permission for each GH_PAGES_BRANCH example to write to the gh-pa…
jyasskin May 16, 2023
24ea557
Link to documentation for setting the right permission.
jyasskin May 16, 2023
fdd371b
nit: Update options.md
sidvishnoi May 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/examples.md
View file
Open in desktop
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
View file
Open in desktop
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