Skip to content

Commit

Permalink
Remove GitHub token build trigger warning (#1517)
Browse files Browse the repository at this point in the history
  • Loading branch information
knuesel authored Feb 11, 2021
1 parent 93e253a commit 8d75805
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 17 deletions.
6 changes: 0 additions & 6 deletions docs/src/man/hosting.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,12 +259,6 @@ to the configuration file, as showed in the [previous section](@ref GitHub-Actio
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.

### Authentication: SSH Deploy Keys

It is also possible to authenticate using a SSH deploy key, just as described in
Expand Down
12 changes: 1 addition & 11 deletions src/deployconfig.jl
Original file line number Diff line number Diff line change
Expand Up @@ -414,17 +414,7 @@ function deploy_folder(cfg::GitHubActions;
end
end

function authentication_method(::GitHubActions)
if env_nonempty("DOCUMENTER_KEY")
return SSH
else
@warn "Currently the GitHub Pages build is not triggered when " *
"using `GITHUB_TOKEN` for authentication. See issue #1177 " *
"(https://github.com/JuliaDocs/Documenter.jl/issues/1177) " *
"for more information."
return HTTPS
end
end
authentication_method(::GitHubActions) = env_nonempty("DOCUMENTER_KEY") ? SSH : HTTPS
function authenticated_repo_url(cfg::GitHubActions)
return "https://$(ENV["GITHUB_ACTOR"]):$(ENV["GITHUB_TOKEN"])@github.com/$(cfg.github_repository).git"
end
Expand Down

0 comments on commit 8d75805

Please sign in to comment.