OpenGL error with Documenter.jl

RobertGregg · July 27, 2022, 12:06am

I’m trying to set up some documentation for a package using Documenter.jl and I’m getting an OpenGL error when I try to build and deploy everything on Github Actions. I have GLMakie as a dependency which is causing the problem, but I’m not sure what to do to resolve the issue.

The specific error message led me to this trouble shooting page and eventually this yaml file for headless github action with GLMakie. Do I just copy that file over to my project?

jules · July 27, 2022, 5:28am

The important lines in our docs workflow are

github.com

JuliaPlots/Makie.jl/blob/1fe9910ada898cbe4fa4f6f272c00fdfdb911119/.github/workflows/Docs.yml#L35


      
          - name: Checkout
            uses: actions/checkout@v2
            with:
              persist-credentials: false
          # NOTE: Python is necessary for the pre-rendering (minification) step
          - name: Install python
            uses: actions/setup-python@v2
            with:
              python-version: '3.8'
          - name: Install binary dependencies
            run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
          # NOTE: Here you can install dependencies such as matplotlib if you use
          # packages such as PyPlot.
          # - run: pip install matplotlib
          - name: Install Julia
            uses: julia-actions/setup-julia@v1
            with:
              version: 1.6
          - name: Build and deploy docs
            env:
              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

and

github.com

JuliaPlots/Makie.jl/blob/1fe9910ada898cbe4fa4f6f272c00fdfdb911119/.github/workflows/Docs.yml#L48


      
          # - run: pip install matplotlib
          - name: Install Julia
            uses: julia-actions/setup-julia@v1
            with:
              version: 1.6
          - name: Build and deploy docs
            env:
              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
            run: >
                cd docs;
                DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24'
                julia --color=yes makedocs.jl
          - name: Upload site as artifact
            uses: actions/upload-artifact@v2
            with:
              name: Docs build
              path: ./docs/__site

Which handle setting up software OpenGL and running the julia process such that it can access those resources.

RobertGregg · July 27, 2022, 3:56pm

Adding those two lines into the default documenter template for github actions solved the issue!

RobertGregg · December 7, 2022, 7:53am

I went to update my project today and unfortunately I’m running into the same error again despite the two modified lines from your previous suggestion. Has GLMakie updated in such a way that I need to add something else to the yml file?

jules · December 7, 2022, 7:56am

We recently had to downgrade our CI to the previous Ubuntu version. The software opengl stack doesn’t seem to work with the new version, yet. You can check our latest CI scripts.