docs: instructions on verifying token access to a repository

README.md

@@ -45,7 +45,7 @@ name: Monthly issue metrics
 on:
   workflow_dispatch:
   schedule:
-    - cron: "3 2 1 * *"
+    - cron: '3 2 1 * *'
 
 permissions:
   contents: read
@@ -110,6 +110,7 @@ All feedback regarding our GitHub Actions, as a whole, should be communicated th
    - Do this by creating a [GitHub API token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) with permissions to read the repository and write issues.
    - Then take the value of the API token you just created, and [create a repository secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets) where the name of the secret is `GH_TOKEN` and the value of the secret the API token.
    - Then finally update the workflow file to use that repository secret by changing `GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}` to `GH_TOKEN: ${{ secrets.GH_TOKEN }}`. The name of the secret can really be anything. It just needs to match between when you create the secret name and when you refer to it in the workflow file.
+   - Help on verifying your token's access to your repository [here](docs/verify-token-access-to-repository.md)
 6. If you want the resulting issue with the metrics in it to appear in a different repository other than the one the workflow file runs in, update the line `token: ${{ secrets.GITHUB_TOKEN }}` with your own GitHub API token stored as a repository secret.
    - This process is the same as described in the step above. More info on creating secrets can be found [here](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
 7. Commit the workflow file to the default branch (often `master` or `main`)

docs/verify-token-access-to-repository.md

@@ -0,0 +1,65 @@
+## Verify Token Access to Repository
+
+Github PAT token access can be confusing. Here's a quick way to test if the token you're using is authorized to access your repository.
+
+**Remove this snippet after you've verified your token.**
+
+- Make sure you follow the token setup instructions [here](https://github.com/github/issue-metrics/tree/main?tab=readme-ov-file#use-as-a-github-action) first.
+
+- Replace `{owner/repo}` with your own repo information.
+
+- Add this snippet to your workflow.yml.
+
+```
+- name: Check GitHub token permissions
+    run: |
+      curl -H "Authorization: token ${{ secrets.GH_TOKEN }}" https://api.github.com/repos/{owner/repo}
+```
+
+- Go to your repository Actions in Github and run your job.
+- In the job run details, click into the results of `Check Github token permissions`
+- You should see your token details with no errors.
+
+Example of the snippet in the full workflow:
+
+```
+name: Monthly issue metrics
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '3 2 1 * *'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: issue metrics
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: read
+
+    steps:
+      - name: Check GitHub token permissions
+        run: |
+          curl -H "Authorization: token ${{ secrets.GH_TOKEN }}" https://api.github.com/{owner/repo}
+      - name: Get dates for last month
+        shell: bash
+        run: |
+          # Calculate the first day of the previous month
+          first_day=$(date -d "last month" +%Y-%m-01)
+
+          # Calculate the last day of the previous month
+          last_day=$(date -d "$first_day +1 month -1 day" +%Y-%m-%d)
+
+          #Set an environment variable with the date range
+          echo "$first_day..$last_day"
+          echo "last_month=$first_day..$last_day" >> "$GITHUB_ENV"
+
+      - name: Run issue-metrics tool
+        uses: github/issue-metrics@v3
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          SEARCH_QUERY: 'repo:{owner/repo} is:issue created:${{ env.last_month }}'
+```