Improve the error message for a missing GITHUB_TOKEN to include the information about the required permissions (#1035)

Kikobeats · Andarist · web-flow · commit b360d50809ed · 2022-12-15T18:08:54.000+01:00
* 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&#324;ski &lt;mateuszburzynski@gmail.com&gt;
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 = {};

-Original file line number
+Diff line change
@@ @@ -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.
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ function makeQuery(repos: ReposWithCommitsAndPRsToFetch) {`
`81`	`81`	`const GHDataLoader = new DataLoader(async (requests: RequestData[]) => {`
`82`	`82`	`if (!process.env.GITHUB_TOKEN) {`
`83`	`83`	`throw new Error(`
`84`		`- "Please create a GitHub personal access token at https://github.com/settings/tokens/new and add it as the GITHUB_TOKEN environment variable"`
	`84`	+ "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"
`85`	`85`	`);`
`86`	`86`	`}`
`87`	`87`	`let repos: ReposWithCommitsAndPRsToFetch = {};`