Documenter.jl deployment issue with repo containing protocol

New to Julia
1

Attempt to deploy docs using Documenter.jl fails following merge into master with the following error:

┌ Info: Deployment criteria for deploying devbranch build from GitHub Actions:
│ - ✔ ENV["GITHUB_REPOSITORY"]="Evovest/EvoTrees.jl" occurs in repo="https://github.com/Evovest/EvoTrees.jl"
│ - ✔ ENV["GITHUB_EVENT_NAME"]="push" is "push"
│ - ✔ ENV["GITHUB_REF"] matches devbranch="master"
│ - ✔ ENV["GITHUB_ACTOR"] exists and is non-empty
│ - ✔ ENV["DOCUMENTER_KEY"] exists and is non-empty
└ Deploying: ✔
ERROR: LoadError: The repo path https://github.com/Evovest/EvoTrees.jl should not contain the protocol

However, the CI completes successully during the PR, it’s only the build step on master which returns the above failure.

I understand from the message error that Documenter.jl expects repo to be Evovest/EvoTrees.jl rather than https://github.com/Evovest/EvoTrees.jl, but given I’m using a vanilla CI configuration, I suspect something else must have gone wrong.

AFAIK, CI could complete prior to adding the DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}, if that may have had any impact.

The CI workflow is the following:

  docs:
    name: Documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: julia-actions/setup-julia@v1
        with:
          version: '1'
      - name: Install dependencies
        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
      - name: Build and deploy
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
        run: julia --project=docs/ docs/make.jl

Any hint on some checks would be welcome!

2

The error message was indeed all that was needed (and some rest time for me to act rationnally), as the fix simply involved an appropriate configuration in the make.jl file:

deploydocs(repo="github.com/Evovest/EvoTrees.jl.git", 
    target="build",
    push_preview=false)
1 Like