From 414c92c5ff594b380dd8df46dffbb34e3dd2343f Mon Sep 17 00:00:00 2001
From: Shohei Ueda <30958501+peaceiris@users.noreply.github.com>
Date: Tue, 17 May 2022 00:40:42 +0900
Subject: [PATCH] docs: add permissions contents write (#753)

---
 .github/workflows/test.yml |  2 ++
 .vscode/.gitignore         |  1 +
 README.md                  | 33 ++++++++++++++++++++++++++++++++-
 3 files changed, 35 insertions(+), 1 deletion(-)
 create mode 100644 .vscode/.gitignore

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 5591f775f..9627fdfaf 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -23,6 +23,8 @@ jobs:
           - 'ubuntu-18.04'
           - 'macos-latest'
           - 'windows-latest'
+    permissions:
+      contents: write
     steps:
       - uses: actions/checkout@v3
 
diff --git a/.vscode/.gitignore b/.vscode/.gitignore
new file mode 100644
index 000000000..397b4a762
--- /dev/null
+++ b/.vscode/.gitignore
@@ -0,0 +1 @@
+*.log
diff --git a/README.md b/README.md
index b9f2b1326..bb118c561 100644
--- a/README.md
+++ b/README.md
@@ -143,6 +143,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
@@ -477,6 +479,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
@@ -570,7 +574,14 @@ fatal: unable to access 'https://github.com/username/repository.git/': The reque
 Error: Action failed with "The process '/usr/bin/git' failed with exit code 128"
 ```
 
-Navigate to your repository's settings / actions / general and in the "Workflow permissions" section, select "Read and write permissions":
+Please add the write permission to the `permissions.contents` in a workflow/job.
+
+```yaml
+permissions:
+  contents: write
+```
+
+Or, navigate to your repository's settings / actions / general and in the "Workflow permissions" section, select "Read and write permissions":
 
 <img width="700" alt="Enabling Read and write permissions to the GITHUB_TOKEN on GitHub Actions" src="https://user-images.githubusercontent.com/30958501/168609359-242f59a9-34c6-4272-9793-d6b2cc823837.png">
 
@@ -622,6 +633,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
@@ -662,6 +675,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
@@ -710,6 +725,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
@@ -760,6 +777,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
@@ -815,6 +834,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
@@ -868,6 +889,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     defaults:
@@ -926,6 +949,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
@@ -986,6 +1011,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
@@ -1025,6 +1052,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
@@ -1069,6 +1098,8 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-20.04
+    permissions:
+      contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps: