# Help with deploying documentation with GitHub Actions

**URL:** <https://discourse.julialang.org/t/help-with-deploying-documentation-with-github-actions/63872>\
**Category:** General Usage\
**Tags:** documenter\
**Created:** [July 1, 2021, 5:46am UTC](https://discourse.julialang.org/t/help-with-deploying-documentation-with-github-actions/63872 "2021-07-01T05:46:01Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![RaulDurand](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/rauldurand/32/2044_2.png) [@RaulDurand](https://discourse.julialang.org/u/RaulDurand)\
**Post date:** [July 1, 2021, 5:46am UTC](https://discourse.julialang.org/t/help-with-deploying-documentation-with-github-actions/63872/1 "2021-07-01T05:46:01Z")

</div>

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

> **[Creating and Deploying your Julia Package Documentation](https://medium.com/coffee-in-a-klein-bottle/creating-and-deploying-your-julia-package-documentation-1d09ddc90474)**
>
> A tutorial on how to create and deploy your Julia Package documentation using Documenter.jl and GitHub Actions.

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

```julia
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.

---

<div class="post-metadata">

**Author:** ![rikh](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/rikh/32/204104_2.png) [@rikh](https://discourse.julialang.org/u/rikh)\
**Post date:** [July 1, 2021, 6:08am UTC](https://discourse.julialang.org/t/help-with-deploying-documentation-with-github-actions/63872/2 "2021-07-01T06:08:56Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![RaulDurand](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/rauldurand/32/2044_2.png) [@RaulDurand](https://discourse.julialang.org/u/RaulDurand)\
**Post date:** [July 1, 2021, 6:19am UTC](https://discourse.julialang.org/t/help-with-deploying-documentation-with-github-actions/63872/3 "2021-07-01T06:19:04Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![fredrikekre](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/fredrikekre/32/1688_2.png) [@fredrikekre](https://discourse.julialang.org/u/fredrikekre)\
**Post date:** [July 1, 2021, 6:22am UTC](https://discourse.julialang.org/t/help-with-deploying-documentation-with-github-actions/63872/4 "2021-07-01T06:22:46Z")

</div>

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](https://numsoftware.github.io/Amaru.jl/dev/)

---

<div class="post-metadata">

**Author:** ![RaulDurand](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/rauldurand/32/2044_2.png) [@RaulDurand](https://discourse.julialang.org/u/RaulDurand)\
**Post date:** [July 1, 2021, 6:27am UTC](https://discourse.julialang.org/t/help-with-deploying-documentation-with-github-actions/63872/5 "2021-07-01T06:27:35Z")

</div>

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.

---

<div class="post-metadata">

**Author:** ![tiago](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/tiago/32/22567_2.png) [@tiago](https://discourse.julialang.org/u/tiago)\
**Post date:** [October 27, 2021, 6:20pm UTC](https://discourse.julialang.org/t/help-with-deploying-documentation-with-github-actions/63872/6 "2021-10-27T18:20:01Z")

</div>

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](https://github.com/tiagoseq/NeuralFieldEq.jl).

Thank you!

---

<div class="post-metadata">

**Author:** ![fredrikekre](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/fredrikekre/32/1688_2.png) [@fredrikekre](https://discourse.julialang.org/u/fredrikekre)\
**Post date:** [October 28, 2021, 12:58pm UTC](https://discourse.julialang.org/t/help-with-deploying-documentation-with-github-actions/63872/7 "2021-10-28T12:58:32Z")

</div>

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](https://discourse.julialang.org/t/documentation-not-deployed-despite-make-jl-saying-it-is/70441/2)).