From 0b24f09f0636321b5f017a671b66f9e122746438 Mon Sep 17 00:00:00 2001
From: Dilum Aluthge <dilum@aluthge.com>
Date: Sat, 8 Oct 2022 05:10:00 -0400
Subject: [PATCH] Migrate the PDF build to Buildkite

---
 .github/workflows/PDFs.yml |  57 ----------
 .gitignore                 |   1 -
 pdf/make.jl                | 207 -------------------------------------
 3 files changed, 265 deletions(-)
 delete mode 100644 .github/workflows/PDFs.yml
 delete mode 100644 pdf/make.jl

diff --git a/.github/workflows/PDFs.yml b/.github/workflows/PDFs.yml
deleted file mode 100644
index ccaf5dbe3b16..000000000000
--- a/.github/workflows/PDFs.yml
+++ /dev/null
@@ -1,57 +0,0 @@
-name: CI
-on:
-  push:
-    branches:
-      - master
-  schedule:
-    - cron: '0 0 * * *' # daily
-  pull_request:
-  workflow_dispatch:
-jobs:
-  pdf:
-    name: Julia PDF builds (${{ matrix.buildtype }})
-    timeout-minutes: 120
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        buildtype:
-          - 'releases'
-          - 'nightly'
-    env:
-      BUILDROOT: ${{ github.workspace }}/pdf/build
-      JULIA_SOURCE: ${{ github.workspace }}/pdf/build/julia
-      JULIA_DOCS: ${{ github.workspace }}/pdf/build/docs.julialang.org
-    steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
-        with:
-          version: 1
-          show-versioninfo: true
-      - uses: actions/cache@v1
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
-      - run: |
-          mkdir $BUILDROOT
-          git clone https://github.com/JuliaLang/julia.git $JULIA_SOURCE
-          git clone https://github.com/JuliaLang/docs.julialang.org.git -b assets --single-branch $JULIA_DOCS
-      - run: julia --color=yes pdf/make.jl ${{ matrix.buildtype }}
-        env:
-          DOCUMENTER_LATEX_DEBUG: ${{ github.workspace }}/latex-debug-logs
-      - uses: actions/upload-artifact@v3
-        if: ${{ always() }}
-        with:
-          name: "LaTeX source and logs (${{ matrix.buildtype }})"
-          path: ${{ github.workspace }}/latex-debug-logs/
-          retention-days: 7 # reduced from the default 90, builds run daily anyway
-      - run: julia --color=yes pdf/make.jl commit
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY_PDF: ${{ secrets.DOCUMENTER_KEY_PDF }}
diff --git a/.gitignore b/.gitignore
index b829a789f964..e69de29bb2d1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +0,0 @@
-/pdf/build/
diff --git a/pdf/make.jl b/pdf/make.jl
deleted file mode 100644
index 5eca6c24d389..000000000000
--- a/pdf/make.jl
+++ /dev/null
@@ -1,207 +0,0 @@
-using Base64
-import Dates
-
-const BUILDROOT      = get(ENV, "BUILDROOT", pwd())
-const JULIA_SOURCE   = get(ENV, "JULIA_SOURCE", "$(BUILDROOT)/julia")
-const JULIA_DOCS     = get(ENV, "JULIA_DOCS", "$(BUILDROOT)/docs.julialang.org")
-const JULIA_DOCS_TMP = get(ENV, "JULIA_DOCS_TMP", "$(BUILDROOT)/tmp")
-
-# download and extract binary for a given version, return path to executable
-function download_release(v::VersionNumber)
-    x, y = v.major, v.minor
-    julia_exec = cd(BUILDROOT) do
-        julia = "julia-$(v)-linux-x86_64"
-        tarball = "$(julia).tar.gz"
-        sha256 = "julia-$(v).sha256"
-        run(`curl -vo $(tarball) -L https://julialang-s3.julialang.org/bin/linux/x64/$(x).$(y)/$(tarball)`)
-        run(`curl -vo $(sha256) -L https://julialang-s3.julialang.org/bin/checksums/$(sha256)`)
-        run(pipeline(`grep $(tarball) $(sha256)`, `sha256sum -c`))
-        mkpath(julia)
-        run(`tar -xzf $(tarball) -C $(julia) --strip-components 1`)
-        return abspath(julia, "bin", "julia")
-    end
-    return julia_exec
-end
-# download and extract nightly binary, return path to executable and commit
-function download_nightly()
-    julia_exec, commit = cd(BUILDROOT) do
-        julia = "julia-latest-linux64"
-        tarball = "$(julia).tar.gz"
-        run(`curl -vo $(tarball) -L https://julialangnightlies-s3.julialang.org/bin/linux/x64/$(tarball)`)
-        # find the commit from the extracted folder
-        folder = first(readlines(`tar -tf $(tarball)`))
-        _, commit = split(folder, '-'); commit = chop(commit)
-        mkpath(julia)
-        run(`tar -xzf $(tarball) -C $(julia) --strip-components 1`)
-        return abspath(julia, "bin", "julia"), commit
-    end
-    return julia_exec, commit
-end
-
-function makedocs(julia_exec)
-    @sync begin
-        builder = @async begin
-            withenv("DOCUMENTER_KEY" => nothing, # skips deploydocs with the BuildBotConfig (see doc/make.jl)
-                    "BUILDROOT" => nothing) do
-                run(`make -C $(JULIA_SOURCE)/doc pdf texplatform=docker JULIA_EXECUTABLE=$(julia_exec)`)
-            end
-        end
-        @async begin
-            while !istaskdone(builder)
-                sleep(60)
-                @info "[$(Dates.format(Dates.now(), raw"yyyy-mm-dd\THH:MM:SS"))] building pdf ..."
-            end
-        end
-    end
-end
-
-function copydocs(file)
-    isdir(JULIA_DOCS_TMP) || mkpath(JULIA_DOCS_TMP)
-    output = "$(JULIA_SOURCE)/doc/_build/pdf/en"
-    destination = "$(JULIA_DOCS_TMP)/$(file)"
-    for f in readdir(output)
-        if startswith(f, "TheJuliaLanguage") && endswith(f, ".pdf")
-            cp("$(output)/$(f)", destination; force=true)
-            @info "finished, output file copied to $(destination)."
-            break
-        end
-    end
-end
-
-function build_release_pdf(v::VersionNumber)
-    @info "building PDF for Julia v$(v)."
-
-    file = "julia-$(v).pdf"
-
-    # early return if file exists
-    if isfile("$(JULIA_DOCS)/$(file)")
-        @info "PDF for Julia v$(v) already exists, skipping."
-        return
-    end
-
-    # download julia binary
-    @info "downloading release tarball."
-    julia_exec = download_release(v)
-
-    # checkout relevant tag and clean repo
-    run(`git -C $(JULIA_SOURCE) checkout v$(v)`)
-    run(`git -C $(JULIA_SOURCE) clean -fdx`)
-
-    # invoke makedocs
-    makedocs(julia_exec)
-
-    # copy built PDF to JULIA_DOCS_TMP
-    copydocs(file)
-end
-
-function build_nightly_pdf()
-    @info "downloading nightly tarball"
-    julia_exec, commit = download_nightly()
-    # output is "julia version 1.1.0-DEV"
-    _, _, v = split(readchomp(`$(julia_exec) --version`))
-    @info "commit determined to $(commit) and version determined to $(v)."
-
-    # checkout correct commit and clean repo
-    run(`git -C $(JULIA_SOURCE) checkout $(commit)`)
-    run(`git -C $(JULIA_SOURCE) clean -fdx`)
-
-    # invoke makedocs
-    makedocs(julia_exec)
-
-    # copy the built PDF to JULIA_DOCS
-    copydocs("julia-$(v).pdf")
-end
-
-# find all tags in the julia repo
-function collect_versions()
-    str = read(`git -C $(JULIA_SOURCE) ls-remote --tags origin`, String)
-    versions = VersionNumber[]
-    for line in eachline(IOBuffer(str))
-        # lines are in the form 'COMMITSHA\trefs/tags/TAG'
-        _, ref = split(line, '\t')
-        _, _, tag = split(ref, '/')
-        if occursin(r"^v\d+\.\d+\.\d+(?:-rc\d+)?$", tag)
-            # the version regex is not as general as Base.VERSION_REGEX -- we only build "pure"
-            # versions and exclude tags that are pre-releases or have build information.
-            v = VersionNumber(tag)
-            # pdf doc only possible for 1.1.0 and above
-            v >= v"1.1.0" || continue
-            # only build RCs if > 1.7
-            v < v"1.7.0" && !isempty(v.prerelease) && continue
-            # exclude 1.8.0 pre-releases, since those fail
-            v"1.8.0-" < v < v"1.8.0" && continue
-            push!(versions, v)
-        end
-    end
-    return versions
-end
-
-# similar to Documenter.deploydocs
-function commit()
-    if get(ENV, "GITHUB_EVENT_NAME", nothing) == "pull_request"
-        @info "skipping commit from pull requests."
-        return
-    end
-    if !isdir(JULIA_DOCS_TMP)
-        @info "No new PDFs created, skipping commit."
-        return
-    end
-    @info "committing built PDF files."
-
-    # Make sure the repo is up to date
-    run(`git fetch origin`)
-    run(`git reset --hard origin/assets`)
-
-    # Copy file from JULIA_DOCS_TMP to JULIA_DOCS
-    for file in readdir(JULIA_DOCS_TMP)
-        endswith(file, ".pdf") || continue
-        from = joinpath(JULIA_DOCS_TMP, file)
-        @debug "Copying a PDF" file from pwd()
-        cp(from, file; force = true)
-    end
-
-    mktemp() do keyfile, iokey; mktemp() do sshconfig, iossh
-        # Set up keyfile
-        write(iokey, base64decode(get(ENV, "DOCUMENTER_KEY_PDF", "")))
-        close(iokey)
-        chmod(keyfile, 0o600)
-        # Set up ssh config file
-        print(iossh,
-            """
-            Host github.com
-               StrictHostKeyChecking no
-               HostName github.com
-               IdentityFile $keyfile
-               BatchMode yes
-            """)
-        close(iossh)
-        chmod(sshconfig, 0o600)
-        # Configure git
-        run(`git config user.name "docs.julialang.org"`)
-        run(`git config user.email "documenter@juliadocs.github.io"`)
-        run(`git remote set-url origin git@github.com:JuliaLang/docs.julialang.org.git`)
-        run(`git config core.sshCommand "ssh -F $(sshconfig)"`)
-        # Committing all .pdf files
-        run(`git add '*.pdf'`)
-        run(`git commit --amend --date=now -m "PDF versions of Julia's manual."`)
-        # Push
-        run(`git push -f origin assets`)
-    end end
-end
-
-function main()
-    if "releases" in ARGS
-        @info "building PDFs for all applicable Julia releases."
-        foreach(build_release_pdf, collect_versions())
-    elseif "nightly" in ARGS
-        @info "building PDF for Julia nightly."
-        build_nightly_pdf()
-    elseif "commit" in ARGS
-        @info "deploying to JuliaLang/docs.julialang.org"
-        cd(() -> commit(), JULIA_DOCS)
-    end
-end
-
-if abspath(PROGRAM_FILE) == @__FILE__
-    main()
-end