add comments about circle token

novalina26 · Mar 25, 2020 · 8ed8087 · 8ed8087
1 parent fabc8dc
commit 8ed8087
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/cy_scripts/scrape.js b/cy_scripts/scrape.js
@@ -33,6 +33,14 @@ function checkToken (token) {
 }
 
 function getCircleCredentials () {
+  // the JSON file should have an object like
+  // { "token": "abc123..." }
+  // where the token is your personal API token from CircleCI
+  // alternatively, put the JSON object into environment variable
+  // with file shown by filenameToShellVariable(jsonFile) call
+  // which is something like _circle_credentials_json
+  // you can load such environment variable quickly from local terminal with
+  // https://github.com/bahmutov/as-a
   const jsonFile = path.join('support', '.circle-credentials.json')
   const config = configFromEnvOrJsonFile(jsonFile)