Skip to content
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

docs(deployment): add GITHUB_TOKEN permission info... #9373

Closed
wants to merge 1 commit into from
Closed

docs(deployment): add GITHUB_TOKEN permission info... #9373

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
18 changes: 18 additions & 0 deletions website/docs/deployment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,24 @@ jobs:

<details>

<summary>GITHUB_TOKEN permissions</summary>

The `GITHUB_TOKEN` is a GitHub secret that is automatically generated when you enable GitHub Actions in your repository. It is used to authenticate the workflow run. You can read more about it [here](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret).

In the default setting, the token has read only access, so the job will fail once it tries to push to the deployment branch.

Configure the permissions:

1. Go to your repository's Settings > Actions > General
2. Scroll to the "Workflow permissions" section
3. Enable "Read and write permissions"

You can specify more granular permissions in the workflow using YAML. [Learn more about managing permissions](https://docs.github.com/actions/reference/authentication-in-a-workflow#modifying-the-permissions-for-the-github_token).

</details>

<details>

<summary>Site not deployed properly?</summary>

After pushing to main, if you don't see your site published at the desired location (for example, it says "There isn't a GitHub Pages site here", or it's showing your repo's README.md file), try the following:
Expand Down