Correctly post GitHub commit status for out-of-repo deployment

[giordano]

At the moment post_status assumes source and deploy repos are the same, it's even completely ignoring the argument which holds the source repo.

I don't know how to test this in CI, but I did test it in NumericalEarth/Breeze.jl#77 (comment).

Fix #2814.

[giordano]

Is there any chance gha.github_repository includes the .git extension? In that case I'd need to drop it with a regex like done below.

[giordano]

Hopefully not

Documenter.jl/src/deployconfig.jl

Line 323 in 5da6aa3

github_repository = get(ENV, "GITHUB_REPOSITORY", "") # "JuliaDocs/Documenter.jl"

? Unless someone really calls this constructor directly with the trailing .git.

[mortenpi]

I think it's fine to assume no .git.

[giordano]

This was helpful for me for debugging: #2814 (comment)

[mortenpi]

This would print the token though, so I am a little bit hesitant to add this.

[mortenpi]

Let's maybe remove this? Or refactor, so that we push! the token after we @debug it? Otherwise, I have no reservations and the PR LGTM.

Suggested change

@debug "About to run curl command" cmd

[giordano]

This would print the token though

Secrets are never printed to screen, they're replaced with asterisks, as in the example I linked above.

[mortenpi]

Only if you're running things in the context where that is true (like on GHA, where the token is a secret). I'd just prefer to be defensive here and never print the secret.

[giordano]

Ok, done.

[navidcy]

@milankl, with this PR Documenter should show the deploy-docs status even when Documenter pushes on a different repo.

SpeedyWeather/SpeedyWeather.jl#720 (comment)

[fingolfin]

I don't claim to understand the details, but (a) I trust @giordano to know what he's doing, and (b) it was tested and worked, so I'd be willing to give it a go

[giordano]

I don't claim to understand the details

The post_github_status function adds a custom commit status to GitHub, which has a link to the deployed documentation. It's all good and simple if source repo and target repos are the same (which is what the current implementation implicitly assumed), but for out-of-repo deployments the two repos are different, so we need to add the custom status to the source repo, but the link should point to the target repo. This is what this PR does (or tries to!) 🙂

[milankl]

This is great, thanks @giordano for your work on this: To clarify, would this deploy docs check automatically pop up when a new version of Documenter is released and used in a repo that deploys docs to another repo? Happy to report back here whether this works but do I need to do anything 😉 ?

[giordano]

would this deploy docs check automatically pop up when a new version of Documenter is released and used in a repo that deploys docs to another repo?

Yes.

do I need to do anything 😉 ?

No, just wait for next release.