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

Jump to bottom

Remove text on GITHUB_TOKEN which is now built-in #8907

Merged
merged 2 commits into from
Dec 16, 2021
Merged

Remove text on GITHUB_TOKEN which is now built-in #8907

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6931710
remove text on GITHUB_TOKEN which is now built-in
letmaik Dec 16, 2021
69a7685
Add link to documentation on `GITHUB_TOKEN`
ashmaroli Dec 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 2 additions & 17 deletions docs/_docs/continuous-integration/github-actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@ The above workflow can be explained as the following:
- We specify our selected **action** and **version number** using `helaili/jekyll-action@2.0.5`.
This handles the build and deploy.
- We set a reference to a secret **environment variable** for the action to use. The `GITHUB_TOKEN`
is a _Personal Access Token_ and is detailed in the next section.
is a secret token automatically initialized at the start of every workflow run.
More information can be found in [GitHub documentation](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret).

Instead of using the **on.push** condition, you could trigger your build on a **schedule** by
using the [on.schedule] parameter. For example, here we build daily at midnight by specifying
Expand All @@ -146,22 +147,6 @@ Note that this string must be quoted to prevent the asterisks from being evaluat
[on.schedule]: https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#onschedule
[crontab guru]: https://crontab.guru/

### Providing permissions

The action needs permissions to push to your `gh-pages` branch. So you need to create a GitHub
**authentication token** on your GitHub profile, then set it as an environment variable in your
build using _Secrets_:

1. On your GitHub profile, under **Developer Settings**, go to the [Personal Access Tokens][tokens]
section.
2. **Create** a token. Give it a name like "GitHub Actions" and ensure it has permissions to
`public_repos` (or the entire `repo` scope for private repository) --- necessary for the action
to commit to the `gh-pages` branch.
3. **Copy** the token value.
4. Go to your repository's **Settings** and then the **Secrets** tab.
5. **Create** a token named `GITHUB_TOKEN` (_important_). Give it a value using the value copied
above.

### Build and deploy

On pushing any local changes onto `main`, the action will be triggered and the build will
Expand Down