docs: suggest right permissions for write access (#159)

Author: jyasskin

docs/examples.md

@@ -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
@@ -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
@@ -174,6 +178,8 @@ jobs:
   main:
     name: Build, Validate and Deploy
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     strategy:
       max-parallel: 1
       matrix:
@@ -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
@@ -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

docs/options.md

@@ -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.