Help with deploying documentation with GitHub Actions

General Usage
1

I followed all steps in the tutorial below to deploy my unregistered package documentation.

However, the gh-pages branch is not updated. It only displays a default GitHub page.
What am I missing?
I enabled Actions and Pages in the repository.
What else do I need to configure in the repository settings?

Locally, the docs are generated ok in the docs/build folder.
My CI.yml file inside .github/workflows is

name: Documentation

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

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: julia-actions/setup-julia@latest
        with:
          version: '1.6'
      - 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

Help is appreciated.

2

What do the GitHub Actions logs say? If your repository is public, can you share the link?

3

Thanks for the answer @rikh
The repo is https://github.com/NumSoftware/Amaru.jl
How do I get the GitHub Actions log?

4

Why do you think it didn’t work? The gh-pages branch was updated just a minute after you pushed to master, and the docs are here: Introduction · Amaru

1 Like
5

By mistake, I was checking (in the browser) the index.html page from the root folder.
Indeed, the docs are in the dev folder. Thanks for clarifying.

6

Hello,

I also followed the same tutorial to setup my documentation and indeed when I check the link for the documentation displays the readme.

My gh-pages branch was updated more than one hour ago. Do I have to do something more? The repository is NeuralFieldEq.jl.

Thank you!

7

Looks like you haven’t enabled gh pages in your repo settings (see Documentation not deployed despite make.jl saying it is - #2 by biona001).

1 Like