Post a GitHub status with a link to generated documentation.

This currently only works on GitHub Actions, but might be possible
to enable on Travis CI too if one adds a (user) access token.

src/Documenter.jl

@@ -586,8 +586,10 @@ function git_push(
             ) do
                 cd(git_commands, temp)
             end
+            post_status(deploy_config; repo=repo, type="success", subfolder=subfolder)
         catch e
             @error "Failed to push:" exception=(e, catch_backtrace())
+            post_status(deploy_config; repo=repo, type="error")
         finally
             # Remove the unencrypted private key.
             isfile(keyfile) && rm(keyfile)
@@ -597,8 +599,10 @@ function git_push(
         upstream = authenticated_repo_url(deploy_config)
         try
             cd(git_commands, temp)
+            post_status(deploy_config; repo=repo, type="success", subfolder=subfolder)
         catch e
             @error "Failed to push:" exception=(e, catch_backtrace())
+            post_status(deploy_config; repo=repo, type="error")
         end
     end
 end

src/deployconfig.jl

@@ -1,3 +1,5 @@
+import JSON
+
 """
     DeployConfig
 
@@ -56,6 +58,9 @@ This method must be supported by configs that push with HTTPS, see
 """
 function authenticated_repo_url end
 
+post_status(cfg::DeployConfig; kwargs...) = nothing
+post_status(; kwargs...) = post_status(auto_detect_deploy_system(); kwargs...)
+
 marker(x) = x ? "✔" : "✘"
 
 #############
@@ -304,6 +309,78 @@ function authenticated_repo_url(cfg::GitHubActions)
 end
 
 
+
+function post_status(::GitHubActions; type, repo::String, subfolder=nothing, kwargs...)
+    try # make this non-fatal and silent
+        # If we got this far it usually means everything is in
+        # order so no need to check everything again.
+        # In particular this is only called after we have
+        # determined to deploy.
+        sha = nothing
+        if get(ENV, "GITHUB_EVENT_NAME", nothing) == "pull_request"
+            event_path = get(ENV, "GITHUB_EVENT_PATH", nothing)
+            event_path === nothing && return
+            event = JSON.parsefile(event_path)
+            if haskey(event, "pull_request") &&
+               haskey(event["pull_request"], "head") &&
+               haskey(event["pull_request"]["head"], "sha")
+               sha = event["pull_request"]["head"]["sha"]
+            end
+        elseif get(ENV, "GITHUB_EVENT_NAME", nothing) == "push"
+            sha = get(ENV, "GITHUB_SHA", nothing)
+        end
+        sha === nothing && return
+        return post_github_status(type, repo, sha, subfolder)
+    catch
+        @debug "Failed to post status"
+    end
+end
+
+function post_github_status(type::S, deploydocs_repo::S, sha::S, subfolder=nothing) where S <: String
+    try
+        Sys.which("curl") === nothing && return
+        ## Exctract owner and repository name
+        m = match(r"^github.com\/(.+?)\/(.+?\.jl)(.git)?$", deploydocs_repo)
+        m === nothing && return
+        owner = String(m.captures[1])
+        repo = String(m.captures[2])
+
+        ## Need an access token for this
+        auth = get(ENV, "GITHUB_TOKEN", nothing)
+        auth === nothing && return
+        # construct the curl call
+        cmd = `curl -sX POST`
+        push!(cmd.exec, "-H", "Authorization: token $(auth)")
+        push!(cmd.exec, "-H", "User-Agent: Documenter.jl")
+        push!(cmd.exec, "-H", "Content-Type: application/json")
+        json = Dict{String,Any}("context" => "continuous-integration/documenter", "state"=>type)
+        if type == "pending"
+            json["description"] = "Documentation build in progress"
+        elseif type == "success"
+            json["description"] = "Documentation build succeeded"
+            if subfolder !== nothing
+                json["target_url"] = "https://$(owner).github.io/$(repo)/$(subfolder)"
+            end
+        elseif type == "error"
+            json["description"] = "Documentation build errored"
+        elseif type == "failure"
+            json["description"] = "Documentation build failed"
+        else
+            error("unsupported type: $type")
+        end
+        push!(cmd.exec, "-d", sprint(JSON.print, json))
+        push!(cmd.exec, "https://api.github.com/repos/$(owner)/$(repo)/statuses/$(sha)")
+        # Run the command (silently)
+        io = IOBuffer()
+        res = run(pipeline(cmd; stdout=io, stderr=devnull))
+        @debug "Response of curl POST request" response=String(take!(io))
+    catch
+        @debug "Failed to post status"
+    end
+    return nothing
+end
+
+
 ##################
 # Auto-detection #
 ##################