Documentation build and depolyment problem: - ✘ `push_preview` keyword argument to deploydocs is `true`

New to Julia
1

I’m developing a package SDPLRPlus.jl and am deploying the documentation. I can compile and view the documentation locally but I have some trouble deploying it. I can see my gh-pages branch is quite different from others’.

I generated the package template using PkgTemplates.jl. I followed the guide of Documenter.jl to generate the deploy key and repo secret. My docs/make.jl is

# see documentation at https://juliadocs.github.io/Documenter.jl/stable/

# If your source directory is not accessible through 
# Julia's LOAD_PATH, you might wish to add the following line 
# at the top of make.jl
push!(LOAD_PATH,"../src/")

using SDPLRPlus
using Documenter
using LuxurySparse 
#using MKLSparse
#using MKL
#using Parameters
#using GenericArpack
#using LinearAlgebra
#using PolynomialRoots
#using Polynomials
#using SparseArrays


makedocs(
    modules = [SDPLRPlus, LuxurySparse],
    authors = "Yufan Huang and the SDPLR authors",
    sitename = "SDPLRPlus.jl",
    format=Documenter.HTML(;
        prettyurls = get(ENV, "CI", nothing) == "true",
        canonical="https://luotuoqingshan.github.io/SDPLRPlus.jl",
        assets=String[],
    ),
    pages = Any["index.md"]
    # strict = true,
    # clean = true,
    # checkdocs = :exports,
)

# Some setup is needed for documentation deployment, see “Hosting Documentation” and
# deploydocs() in the Documenter manual for more information.
deploydocs(;
    repo = "github.com/luotuoqingshan/SDPLRPlus.jl",
    devbranch = "main",
    push_preview = false,
)

and my workflow file looks like

# see https://juliadocs.github.io/Documenter.jl/dev/man/hosting/#GitHub-Actions
# add this file to the repository once you set up authentication as described in the Documenter manual

name: Documentation

on:
  push:
    branches:
      - master
    tags: '*'
  pull_request:

jobs:
  build:
    permissions:
      contents: write
      pull-requests: read
      statuses: write
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: julia-actions/setup-julia@latest
        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

This workflow passes but when I was checking the log of Documentation Build, in the stage of Build and deploy, it reports

┌ Info: Deployment criteria for deploying preview build from GitHub Actions:
│ - ✔ ENV["GITHUB_REPOSITORY"]="luotuoqingshan/SDPLRPlus.jl" occurs in repo="github.com/luotuoqingshan/SDPLRPlus.jl"
│ - ✔ ENV["GITHUB_REF"] corresponds to a PR number
│ - ✔ PR originates from the same repository
│ - ✘ `push_preview` keyword argument to deploydocs is `true`
│ - ✔ ENV["GITHUB_ACTOR"] exists and is non-empty
│ - ✔ ENV["DOCUMENTER_KEY"] exists and is non-empty
└ Deploying: ✘

I got confused. I double checked and confirmed that my github pages have source from a branch and it’s set to gh-pages, folder /root.

  1. I’m not sure if Deploying: ✘ is the reason that my gh-pages look a bit different.
  2. I used to copy a setting with push_preview=true. After seeing this error I have turned it off, but why is it still saying that?

I’m quite new to these github workflows, any help helps!

2

I revisited it today. It was a branch name issue (checking github issue is useful), after changing the master in the documentation.yml to main, it works now.