Add token details in generate preview

d12frosted · Sep 8, 2020 · 2c55a46 · 2c55a46
1 parent 4bca35b
commit 2c55a46
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/dist/index.js b/dist/index.js
@@ -20188,6 +20188,10 @@ const generatePreviewMarkdown = function (isInGithubAction) {
 # Preview Cards
 
 Here are all cards with themes.
+| :warning: | If your workflow does not generate all cards in output folder, then you need to use [Personal access token](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) instead of GITHUB_TOKEN in workflow. |
+| :-------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+
+[Personal token need those permission](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Personal-access-token-permissions)
 
 `;
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "github-profile-summary-cards",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Generate github profile summary cards",
   "main": "src/app.js",
   "scripts": {

diff --git a/src/utils/file-writer.js b/src/utils/file-writer.js
@@ -38,6 +38,10 @@ const generatePreviewMarkdown = function (isInGithubAction) {
 # Preview Cards
 
 Here are all cards with themes.
+| :warning: | If your workflow does not generate all cards in output folder, then you need to use [Personal access token](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) instead of GITHUB_TOKEN in workflow. |
+| :-------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+
+[Personal token need those permission](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Personal-access-token-permissions)
 
 `;