update scopes for GH token (#400)

mondoohq · Oct 9, 2024 · e1827d5 · e1827d5
1 parent 6eb3746
commit e1827d5
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/docs/cnquery/saas/github.md b/docs/cnquery/saas/github.md
@@ -17,7 +17,13 @@ To query GitHub organizations and repos, cnquery needs access. You give cnquery
 
 cnquery needs a personal access token to query a GitHub organization, public repo, or private repo. The token's level of access determines how much information cnquery can retrieve.
 
-To learn how to create a personal access token, read [Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) in the GitHub documentation.
+To learn how to create a personal access token, read [Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) in the GitHub documentation. We recommend creating a classic token with these scopes:
+
+- public_repo
+- read:org
+- read:repo_hook
+- admin:org_hook
+- read:project
 
 #### Configure a GITHUB_TOKEN environment variable
 

diff --git a/docs/cnspec/saas/github.md b/docs/cnspec/saas/github.md
@@ -25,7 +25,13 @@ To scan GitHub organizations and repos, cnspec needs access. You give cnspec the
 
 cnspec needs a personal access token to scan a GitHub organization, public repo, or private repo. The token's level of access determines how much information cnspec can retrieve.
 
-To learn how to create a personal access token, read [Managing your personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) in the GitHub documentation.
+To learn how to create a personal access token, read [Managing your personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) in the GitHub documentation. We recommend creating a classic token with these scopes:
+
+- public_repo
+- read:org
+- read:repo_hook
+- admin:org_hook
+- read:project
 
 #### Configure a GITHUB_TOKEN environment variable
 

diff --git a/docs/platform/infra/saas/github.mdx b/docs/platform/infra/saas/github.mdx
@@ -41,6 +41,7 @@ To learn more about personal access tokens, read [Managing your personal access
 
 8. Under **Select scopes**, check these boxes:
 
+   - public_repo
    - read:org
    - read:repo_hook
    - admin:org_hook