Skip to content

Commit ae09900

Browse files
authored
docs(contributing): add instructions to generate github token (#7652)
* docs(contributing): add instructions to generate github token * chore: add command fetch-all and update contributing docs
1 parent d803b54 commit ae09900

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,21 @@ Start by ensuring that you have Node.js installed and forking the repository:
1313
- Fork the **webpack.js.org** repo from [the main repository][2].
1414
- `git clone <your-clone-url> && cd webpack.js.org`
1515

16+
> To run the project, you must run scripts that download the website content from GitHub.
17+
> To avoid hitting rate limits, you'll need to use your GitHub token.
18+
> The build scripts (`fetch-repo` and `fetch:*` commands) use this token to retrieve repository data,
19+
> including documentation, examples, and contributors.
20+
> If you do not have one, you can create it on the [GitHub Personal Access Tokens page](https://github.com/settings/personal-access-tokens).
21+
1622
Once you are in the project directory, run the following commands:
1723

1824
- `yarn` to pull all dependencies.
25+
- `GITHUB_TOKEN=<your-token-here> yarn fetch-all` - Fetches all updated website content from GitHub.
1926
- `yarn build` to create a production version of the site.
2027
- `yarn start` to develop on a local webpack-dev-server: [localhost:3000][3].
2128

29+
**Note:** The `fetch` and `fetch-repos` commands must be run before building the site as they populate necessary data for the build process.
30+
2231
> NOTE: run `yarn fetch-repos` and then `yarn fetch` before running `yarn start` command for the first time
2332
2433
- `yarn fetch` to retrieve external documentation/data.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
"fetch": "run-p fetch:*",
3636
"fetch:readmes": "node src/utilities/fetch-package-readmes.mjs",
3737
"fetch:supporters": "node src/utilities/fetch-supporters.mjs",
38+
"fetch-all": "run-s fetch-repos fetch",
3839
"prebuild": "npm run clean",
3940
"build": "run-s fetch-repos fetch content && webpack --config webpack.prod.mjs --config-node-env production && run-s printable content && webpack --config webpack.ssg.mjs --config-node-env production --env ssg",
4041
"postbuild": "npm run sitemap",

0 commit comments

Comments
 (0)