Skip to content

docs(contributing): add instructions to generate github token #7652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(contributing): add instructions to generate github token #7652

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,15 @@ Start by ensuring that you have Node.js installed and forking the repository:
- Fork the **webpack.js.org** repo from [the main repository][2].
- `git clone <your-clone-url> && cd webpack.js.org`

Some operations in the build process require a GitHub token. To create and export one:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mention the fetch scripts here. Also, I think we can do this instead:

GITHUB_TOKEN=123 node fetch-path.js


- Go to [GitHub Personal Access Tokens](https://github.com/settings/personal-access-tokens) and generate a new token with the repo and workflow scopes.
- Export it in your terminal before running build or fetch commands:

Once you are in the project directory, run the following commands:

- `yarn` to pull all dependencies.
- `yarn build` to create a production version of the site.
- `export GITHUB_TOKEN=<your-token-here> yarn build` to create a production version of the site.
- `yarn start` to develop on a local webpack-dev-server: [localhost:3000][3].

> NOTE: run `yarn fetch-repos` and then `yarn fetch` before running `yarn start` command for the first time
Expand Down
Loading