dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Merge pull request 8907
This commit is contained in:
Maik Riechert 2021-12-16 14:54:55 +01:00 committed by GitHub
parent 23284eb6db
commit 23af360ef0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/_docs/continuous-integration/github-actions.md
View File

@ -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`. - We specify our selected **action** and **version number** using `helaili/jekyll-action@2.0.5`.
This handles the build and deploy. This handles the build and deploy.
- We set a reference to a secret **environment variable** for the action to use. The `GITHUB_TOKEN` - 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 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 using the [on.schedule] parameter. For example, here we build daily at midnight by specifying
@ -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 [on.schedule]: https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#onschedule
[crontab guru]: https://crontab.guru/ [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 ### Build and deploy
On pushing any local changes onto `main`, the action will be triggered and the build will On pushing any local changes onto `main`, the action will be triggered and the build will