From d65d9f5502343248dbb219f4050ebdec1d962e89 Mon Sep 17 00:00:00 2001 From: Brandon Taylor Date: Sat, 15 Feb 2020 22:00:19 -0500 Subject: [PATCH 1/3] GitHub token workaround --- docs/src/man/hosting.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/docs/src/man/hosting.md b/docs/src/man/hosting.md index f357c439a0..7a4dfa0f89 100644 --- a/docs/src/man/hosting.md +++ b/docs/src/man/hosting.md @@ -81,7 +81,7 @@ The three lines in the `script:` section do the following: Travis CI used to use `matrix:` as the section to configure to build matrix in the config file. This now appears to be a deprecated alias for `jobs:`. If you use both `matrix:` and `jobs:` in your configuration, `matrix:` overrides the settings under `jobs:`. - + If your `.travis.yml` file still uses `matrix:`, it should be replaced with a a single `jobs:` section. @@ -216,9 +216,13 @@ see the previous section. ### Authentication: `GITHUB_TOKEN` -When running from GitHub Actions it is possible to authenticate using -[the GitHub Actions authentication token -(`GITHUB_TOKEN`)](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token). This is done by adding +When running from GitHub Actions it is possible to authenticate using a personal +access token. + +First, create a new personal access token named "GITHUB_TOKEN" with +the "repo" scope checked [here](https://github.com/settings/tokens/new). + +Then, add ```yaml GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -227,15 +231,9 @@ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} to the configuration file, as showed in the [previous section](@ref GitHub-Actions). !!! note - You can only use `GITHUB_TOKEN` for authentication if the target repository - of the deployment is the same as the current repository. In order to push - elsewhere you should instead use a SSH deploy key. - -!!! warning "GitHub Pages and GitHub Token" - Currently the GitHub Page build is not triggered when the GitHub provided - `GITHUB_TOKEN` is used for authentication. See - [issue #1177](https://github.com/JuliaDocs/Documenter.jl/issues/1177) - for more information. + While GitHub will automatically create a github token for you named "GITHUB" + token for you, it will not have push access. Therefore, you must override + GitHub my making a new key with the same name. ### Authentication: SSH Deploy Keys From 4dba51041b014a8eaaae85aea240bd756fd63a1a Mon Sep 17 00:00:00 2001 From: Brandon Taylor Date: Sat, 15 Feb 2020 22:02:27 -0500 Subject: [PATCH 2/3] fix --- docs/src/man/hosting.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/man/hosting.md b/docs/src/man/hosting.md index 7a4dfa0f89..861ffad625 100644 --- a/docs/src/man/hosting.md +++ b/docs/src/man/hosting.md @@ -231,9 +231,9 @@ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} to the configuration file, as showed in the [previous section](@ref GitHub-Actions). !!! note - While GitHub will automatically create a github token for you named "GITHUB" - token for you, it will not have push access. Therefore, you must override - GitHub my making a new key with the same name. + While GitHub will automatically create a github token for you named "GITHUB_TOKEN", + it will not have push access. Therefore, you must override + GitHub my making a personal access token with the same name. ### Authentication: SSH Deploy Keys From 8b1f640178cf4462d7dcae5d4b873b2b7f793ec6 Mon Sep 17 00:00:00 2001 From: Brandon Taylor Date: Sat, 15 Feb 2020 22:03:13 -0500 Subject: [PATCH 3/3] fix --- docs/src/man/hosting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/man/hosting.md b/docs/src/man/hosting.md index 861ffad625..16cd0e4d6a 100644 --- a/docs/src/man/hosting.md +++ b/docs/src/man/hosting.md @@ -233,7 +233,7 @@ to the configuration file, as showed in the [previous section](@ref GitHub-Actio !!! note While GitHub will automatically create a github token for you named "GITHUB_TOKEN", it will not have push access. Therefore, you must override - GitHub my making a personal access token with the same name. + GitHub by making a new personal access token with the same name. ### Authentication: SSH Deploy Keys