# Github action stable and dev documentations

**URL:** https://discourse.julialang.org/t/github-action-stable-and-dev-documentations/84385
**Category:** General Usage
**Tags:** documentation, github-actions
**Created:** [July 18, 2022, 8:11am UTC](https://discourse.julialang.org/t/github-action-stable-and-dev-documentations/84385 "2022-07-18T08:11:39Z")
**Posts on this page:** 9
**Page:** 1

<div class="post-metadata">

### Author: ![\_stla](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/_stla/32/35613_2.png) [@\_stla](https://discourse.julialang.org/u/_stla)
#### Post date: [July 18, 2022, 8:11am UTC](https://discourse.julialang.org/t/github-action-stable-and-dev-documentations/84385/1 "2022-07-18T08:11:39Z")

</div>

Hello,

I’d like to register my package [JackPolynomials](https://github.com/stla/JackPolynomials.jl) (and others). I have a Github action for the documentation:

```yaml
  docs:
    name: Documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: julia-actions/setup-julia@v1
        with:
          version: '1'
      - run: |
          julia --project=docs -e '
            using Pkg
            Pkg.develop(PackageSpec(path=pwd()))
            Pkg.instantiate()'
      - run: |
          julia --project=docs -e '
            using Documenter: doctest
            using JackPolynomials
            doctest(JackPolynomials)'
      - run: julia --project=docs docs/make.jl
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

This generates the documentation at [https://stla.github.io/JackPolynomials.jl/dev/](https://stla.github.io/JackPolynomials.jl/dev/). How to generate the documentation for a stable release? I took a look at the Github repo of some registered packages but I can’t figure out.

---

<div class="post-metadata">

### Author: ![kellertuer](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/kellertuer/32/220707_2.png) [@kellertuer](https://discourse.julialang.org/u/kellertuer)
#### Post date: [July 18, 2022, 8:26am UTC](https://discourse.julialang.org/t/github-action-stable-and-dev-documentations/84385/2 "2022-07-18T08:26:40Z")

</div>

If you add the TagBot ([GitHub - JuliaRegistries/TagBot: Creates tags, releases, and changelogs for your Julia packages when they're registered](https://github.com/JuliaRegistries/TagBot)) and make sure your docs action also runs on tags (see for example [Manifolds.jl/documenter.yml at master · JuliaManifolds/Manifolds.jl · GitHub](https://github.com/JuliaManifolds/Manifolds.jl/blob/master/.github/workflows/documenter.yml) ), then this happens automatically each time you register a new version (that is when the TagBot creates a new Tag).

---

<div class="post-metadata">

### Author: ![\_stla](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/_stla/32/35613_2.png) [@\_stla](https://discourse.julialang.org/u/_stla)
#### Post date: [July 18, 2022, 8:29am UTC](https://discourse.julialang.org/t/github-action-stable-and-dev-documentations/84385/3 "2022-07-18T08:29:22Z")

</div>

Thank you, I will try that today I think.

---

<div class="post-metadata">

### Author: ![\_stla](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/_stla/32/35613_2.png) [@\_stla](https://discourse.julialang.org/u/_stla)
#### Post date: [July 18, 2022, 8:39am UTC](https://discourse.julialang.org/t/github-action-stable-and-dev-documentations/84385/4 "2022-07-18T08:39:13Z")

</div>

Your **documenter.yml** file is very different of mine. In particular it does not include the line **julia --project=docs docs/make.jl** , and this is the command which generates the doc. How does this work? 🤔

---

<div class="post-metadata">

### Author: ![kellertuer](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/kellertuer/32/220707_2.png) [@kellertuer](https://discourse.julialang.org/u/kellertuer)
#### Post date: [July 18, 2022, 8:45am UTC](https://discourse.julialang.org/t/github-action-stable-and-dev-documentations/84385/5 "2022-07-18T08:45:08Z")

</div>

Magic! 🪄

We both use the actions to checkout and setup Julia, but your manual steps are basically just the action [GitHub - julia-actions/julia-docdeploy](https://github.com/julia-actions/julia-docdeploy) to which we pass the GitHub token and the documenter key (both used for deployment of the docs, but I am not 100% sure the documenter key is still needed).

Two other differences we have (but you can ignore):

1. The `docs:` job only runs on master, tags or PRs, but for PRs only those where a certain tag is present (this way we do not built docs on arbitrary PRs where we do not change the docs)
2. the `note:` job displays a note if the documentation is not run, to tell the first point to the user.

Basically, you can ignore our lines 12 and 23-29

---

<div class="post-metadata">

### Author: ![\_stla](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/_stla/32/35613_2.png) [@\_stla](https://discourse.julialang.org/u/_stla)
#### Post date: [July 18, 2022, 12:39pm UTC](https://discourse.julialang.org/t/github-action-stable-and-dev-documentations/84385/6 "2022-07-18T12:39:39Z")

</div>

Thanks. Now I’m trying to register with the [Julia Registrator](https://github.com/JuliaComputing/Registrator.jl).

---

<div class="post-metadata">

### Author: ![kellertuer](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/kellertuer/32/220707_2.png) [@kellertuer](https://discourse.julialang.org/u/kellertuer)
#### Post date: [July 18, 2022, 5:12pm UTC](https://discourse.julialang.org/t/github-action-stable-and-dev-documentations/84385/7 "2022-07-18T17:12:24Z")

</div>

Good luck, I love this bot, since it really makes registration easy (and I hope your compat-section is complete), if there are mistakes (like compat entries missing) you will get feedback on that as well.

---

<div class="post-metadata">

### Author: ![\_stla](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/_stla/32/35613_2.png) [@\_stla](https://discourse.julialang.org/u/_stla)
#### Post date: [July 18, 2022, 7:28pm UTC](https://discourse.julialang.org/t/github-action-stable-and-dev-documentations/84385/8 "2022-07-18T19:28:49Z")

</div>

Yes, nice bot.

I have a package dependent on **LinearAlgebra** but I looked on the Github repo of this package and it has no version. So what should I put in **compat**?

---

<div class="post-metadata">

### Author: ![mortenpi](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mortenpi/32/158_2.png) [@mortenpi](https://discourse.julialang.org/u/mortenpi)
#### Post date: [July 18, 2022, 9:54pm UTC](https://discourse.julialang.org/t/github-action-stable-and-dev-documentations/84385/9 "2022-07-18T21:54:51Z")

</div>

`LinearAlgebra` is a standard library and comes [bundled with Julia](https://github.com/JuliaLang/julia/tree/master/stdlib/LinearAlgebra). Setting a version restriction on this would not have any effect and should not be done.
