Inconsistent documentation generation behaviors

Mark_Nahabedian · July 8, 2022, 6:41pm

The documentation for Documenter.jl describes how to write a docs/make.jl ile to generate documentation.

julia-docdeploy/action.yml at master · julia-actions/julia-docdeploy · GitHub doesn’t use that file. When one builds docs by hand locally using docs/make.jl, one gets different behavior than when GitHub runs ci.yml.

Is there any reason for this perverse inconsistency?

How should I fix it for my project?

Thanks.

fredrikekre · July 8, 2022, 10:01pm

github.com

julia-actions/julia-docdeploy/blob/80c0bdcd0ea677beb566454f5290c4f803b59b64/action.yml#L49


      
            if: ${{ inputs.install-package }}
          - run: |
              # The Julia command that will be executed
              julia_cmd=( julia --color=yes --project=docs/ -e '
                  @eval Module() begin
                      push!(LOAD_PATH, "@docs-logger-env") # access GitHubActions.jl
                      import Logging, GitHubActions
                      Logging.global_logger(GitHubActions.GitHubActionsLogger())
                      pop!(LOAD_PATH)
                  end
                  include("docs/make.jl")' )
          
              # Add the prefix in front of the command if there is one
              prefix="${{ inputs.prefix }}"
              [[ -n $prefix ]] && julia_cmd=( "$prefix" "${julia_cmd[@]}" )
          
              # Run the Julia command
              "${julia_cmd[@]}"
            shell: bash

Mark_Nahabedian · July 8, 2022, 10:29pm

Doooo! How did I miss that?

Sorry. Thanks.