Improve the error message for a missing GITHUB_TOKEN to include the…

… information about the required permissions (#1035) * specify token permissions in the error message * Create tricky-months-whisper.md * Update .changeset/tricky-months-whisper.md * Update packages/get-github-info/src/index.ts Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
changesets · Dec 15, 2022 · b360d50 · b360d50
1 parent c606dc6
commit b360d50
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.changeset/tricky-months-whisper.md b/.changeset/tricky-months-whisper.md
@@ -0,0 +1,5 @@
+---
+"@changesets/get-github-info": patch
+---
+
+Improved the error message for a missing `GITHUB_TOKEN` to include the information about the required permissions.
diff --git a/packages/get-github-info/src/index.ts b/packages/get-github-info/src/index.ts
@@ -81,7 +81,7 @@ function makeQuery(repos: ReposWithCommitsAndPRsToFetch) {
 const GHDataLoader = new DataLoader(async (requests: RequestData[]) => {
   if (!process.env.GITHUB_TOKEN) {
     throw new Error(
-      "Please create a GitHub personal access token at https://github.com/settings/tokens/new and add it as the GITHUB_TOKEN environment variable"
+      "Please create a GitHub personal access token at https://github.com/settings/tokens/new with `read:user` and `repo:status` permissions and add it as the GITHUB_TOKEN environment variable"
     );
   }
   let repos: ReposWithCommitsAndPRsToFetch = {};