Skip to content

Commit

Permalink
Update scripts/gatsby-plugin-checker/README.md
Browse files Browse the repository at this point in the history
rename GITHUB_PERSONAL_ACCESS_TOKEN to GITHUB_API_TOKEN in docs

Co-Authored-By: Dustin Schau <DSchau@users.noreply.github.com>
  • Loading branch information
dmarkiewicz and DSchau authored May 14, 2019
1 parent 7c320d3 commit 0630785
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion scripts/gatsby-plugin-checker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This script searches the npm API for plugins that start with either "gatsby-source", "gatsby-plugin", or "gatsby-transformer" but don't have the "gatsby-plugin" keyword in their `package.json` and thus are not included in Gatsby's keyword search. The script will then notify those repositories by creating an issue notifying them to add the keyword to their `package.json` (This functionality will be included in the next commit). Once a repo has been notified, its `notified` attribute will be changed to `true` in `plugins.json` and won't be notified. Similarly, if a repo is a false positive or doesn't want to be notified, it can be `blacklisted`.

To run this script you have to create a `.env` file in this directory and create there a variable `GITHUB_PERSONAL_ACCESS_TOKEN` and assign there your personal access token. You can find an instruction for generating it [here](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line). You shouldn't commit `.env` file.
To run this script you have to create a `.env` file in this directory and create there a variable `GITHUB_API_TOKEN` and assign there your personal access token. You can find an instruction for generating it [here](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line). You shouldn't commit `.env` file.

0 comments on commit 0630785

Please sign in to comment.