Merge pull request #21 from aws-github-ops/khushail/readmeUpdate

chore: added write permissions section in the Readme

Author: peterwoodworth

.github/workflows/handle-stale-discussions.yml

@@ -9,9 +9,11 @@ jobs:
   handle-stale-discussions:
     name: Handle stale discussions
     runs-on: ubuntu-latest
+    permissions:
+      discussions: write
     steps:
       - name: Stale discussions action
-        uses: aws-github-ops/handle-stale-discussions@main
+        uses: aws-github-ops/handle-stale-discussions@v1
         env:
           GITHUB_TOKEN:  ${{secrets.GITHUB_TOKEN}}
 

README.md

@@ -8,7 +8,10 @@ In addition to handling proposed answers, this action will automatically close a
 
 ## Steps to enable this action in your repository
 
-1. A valid GitHub token is required to use this action. The GITHUB_TOKEN for your repository can be generated by GitHub during workflow execution when passed in as `${{ secrets.GITHUB_TOKEN }}`. Please check the permissions in Repository settings to grant write permissions to the token.
+1. A valid GitHub token is required to use this action. The GitHub token for your repository can be generated by GitHub during workflow execution when passed in as `${{ secrets.GITHUB_TOKEN }}`. The GitHub token must have <b>discussions: write permissions</b>, these permissions can be granted in the workflow file.
+
+Alternatively, write permissions can be granted to your repository's GitHub token for all workflows in your repository. Please check the permissions in your Repository `Settings -> Actions -> General` to grant write permissions to the token.
+
 
 ![Action Settings in repo](images/repoTokenSettings.png)
 
@@ -32,8 +35,10 @@ jobs:
   run-action:
     name: Handle stale discussions
     runs-on: ubuntu-latest
+    permissions:
+      discussions: write
     steps:
-      - uses: aws-github-ops/handle-stale-discussions@main
+      - uses: aws-github-ops/handle-stale-discussions@v1
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           attention-label: needs-attention