Skip to content

Commit 8d75805

Browse files
authored
Remove GitHub token build trigger warning (#1517)
1 parent 93e253a commit 8d75805

File tree

2 files changed

+1
-17
lines changed

2 files changed

+1
-17
lines changed

docs/src/man/hosting.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -259,12 +259,6 @@ to the configuration file, as showed in the [previous section](@ref GitHub-Actio
259259
of the deployment is the same as the current repository. In order to push
260260
elsewhere you should instead use a SSH deploy key.
261261

262-
!!! warning "GitHub Pages and GitHub Token"
263-
Currently the GitHub Page build is not triggered when the GitHub provided
264-
`GITHUB_TOKEN` is used for authentication. See
265-
[issue #1177](https://github.com/JuliaDocs/Documenter.jl/issues/1177)
266-
for more information.
267-
268262
### Authentication: SSH Deploy Keys
269263

270264
It is also possible to authenticate using a SSH deploy key, just as described in

src/deployconfig.jl

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -414,17 +414,7 @@ function deploy_folder(cfg::GitHubActions;
414414
end
415415
end
416416

417-
function authentication_method(::GitHubActions)
418-
if env_nonempty("DOCUMENTER_KEY")
419-
return SSH
420-
else
421-
@warn "Currently the GitHub Pages build is not triggered when " *
422-
"using `GITHUB_TOKEN` for authentication. See issue #1177 " *
423-
"(https://github.com/JuliaDocs/Documenter.jl/issues/1177) " *
424-
"for more information."
425-
return HTTPS
426-
end
427-
end
417+
authentication_method(::GitHubActions) = env_nonempty("DOCUMENTER_KEY") ? SSH : HTTPS
428418
function authenticated_repo_url(cfg::GitHubActions)
429419
return "https://$(ENV["GITHUB_ACTOR"]):$(ENV["GITHUB_TOKEN"])@github.com/$(cfg.github_repository).git"
430420
end

0 commit comments

Comments
 (0)