Dev version of Documenter.jl on GitHub Actions

tfiers · December 10, 2022, 3:28am

I installed an unreleased version of Documenter in a package’s docs/Project.toml (docs/Manifest.toml is committed).

Local docs build works.

But, on github, julia-actions/julia-docdeploy gives:

ERROR: expected package `Documenter [e30172f5]` to exist at path `/home/runner/.julia/packages/Documenter/4bxAC`

(Link.
This is when it runs sth like julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()').

What am I doing wrong?

tfiers · December 10, 2022, 5:26am

Solution was to add a custom run step, with Pkg.instantiate(), before julia-docdeploy:

github.com

tfiers/PkgGraph.jl/blob/112abcc/.github/workflows/Documentation.yml#L30


      
          docs:
            runs-on: ubuntu-latest
            permissions:
              contents: write
            steps:
              - uses: actions/checkout@v2
              - uses: julia-actions/setup-julia@v1
                with:
                  version: '1'
              - uses: julia-actions/cache@v1
              - run: julia --project=docs -e 'using Pkg; Pkg.instantiate()'
              - uses: julia-actions/julia-docdeploy@v1
                env:
                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Thanks @Mark_Nahabedian in the slack for the help!

fredrikekre · December 10, 2022, 6:03am

If you are committing the manifest I would suggest just Pkg.develop your own package there too, using a relative path. This lets you only intantiate on CI (i.e. no develop there).

tfiers · December 10, 2022, 6:40pm

Yes I agree (my package is already relative / dev’ed in docs/Manifest.toml)

It’s the ‘docdeploy’ GitHub Action that internally does the (superfluous) Pkg.develop.

The docdeploy action has a install-package = false option; but setting that didn’t help this issue iirc.