docs(readme): add permissions only for the new options

actions · Jun 10, 2021 · 09d1712 · 09d1712
1 parent 7122032
commit 09d1712
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -316,19 +316,22 @@ Default value: unset
 
 Automatically remove the stale label when the issues or the pull requests are commented.
 
-Default value: `true`
+Default value: `true`  
+Required Permission: `issues: write` and `pull-requests: write`
 
 #### remove-issue-stale-when-commented
 
 Override [remove-stale-when-commented](#remove-stale-when-commented) but only to automatically remove the stale label when the issues are commented.
 
-Default value: unset
+Default value: unset  
+Required Permission: `issues: write` and `pull-requests: write`
 
 #### remove-pr-stale-when-commented
 
 Override [remove-stale-when-commented](#remove-stale-when-commented) but only to automatically remove the stale label when the pull requests are commented.
 
-Default value: unset
+Default value: unset  
+Required Permission: `issues: write` and `pull-requests: write`
 
 #### labels-to-add-when-unstale
 

diff --git a/__tests__/main.spec.ts b/__tests__/main.spec.ts
@@ -1259,7 +1259,7 @@ test('when the option "labelsToAddWhenUnstale" is set, the labels should be adde
   expect.assertions(4);
   const opts = {
     ...DefaultProcessorOptions,
-    removeStaleWhenUpdated: true,
+    removeStaleWhenCommented: true,
     labelsToAddWhenUnstale: 'test'
   };
   const TestIssueList: Issue[] = [