Skip to content

Better deployment of rc docs #36859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 31, 2020
Merged

Better deployment of rc docs #36859

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50c4e67
rc docs: strip extra pre-release info, deploy to e.g. 1.5.0-rc2 inste…
fredrikekre Jul 30, 2020
cd4330d
rc docs: hack Documenter to insert rc docs in the version selector.
fredrikekre Jul 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions doc/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,10 @@ struct BuildBotConfig <: Documenter.DeployConfig end
function Documenter.deploy_folder(::BuildBotConfig; devurl, kwargs...)
haskey(ENV, "DOCUMENTER_KEY") || return nothing
if Base.GIT_VERSION_INFO.tagged_commit
return "v$(Base.VERSION)"
# Strip extra pre-release info (1.5.0-rc2.0 -> 1.5.0-rc2)
ver = VersionNumber(VERSION.major, VERSION.minor, VERSION.patch,
isempty(VERSION.prerelease) ? () : (VERSION.prerelease[1],))
return "v$(ver)"
elseif Base.GIT_VERSION_INFO.branch == "master"
return devurl
end
Expand All @@ -230,11 +233,33 @@ end

const devurl = "v$(VERSION.major).$(VERSION.minor)-dev"

# Hack to make rc docs visible in the version selector
struct Versions versions end
function Documenter.Writers.HTMLWriter.expand_versions(dir::String, v::Versions)
# Find all available docs
available_folders = readdir(dir)
cd(() -> filter!(!islink, available_folders), dir)
filter!(x -> occursin(Base.VERSION_REGEX, x), available_folders)

# Look for docs for an "active" release candidate and insert it
vnums = [VersionNumber(x) for x in available_folders]
master_version = maximum(vnums)
filter!(x -> x.major == 1 && x.minor == master_version.minor-1, vnums)
rc = maximum(vnums)
if !isempty(rc.prerelease) && occursin(r"^rc", rc.prerelease[1])
src = "v$(rc)"
@assert src ∈ available_folders
push!(v.versions, src => src, pop!(v.versions))
end

return Documenter.Writers.HTMLWriter.expand_versions(dir, v.versions)
end

deploydocs(
repo = "github.com/JuliaLang/docs.julialang.org.git",
deploy_config = BuildBotConfig(),
target = joinpath(buildroot, "doc", "_build", "html", "en"),
dirname = "en",
devurl = devurl,
versions = ["v#.#", devurl => devurl]
versions = Versions(["v#.#", devurl => devurl]),
)