Add Documenter key and warinng about SSH setup (#460)

JuliaCI · Feb 9, 2024 · a775fe5 · a775fe5
1 parent 6f6c392
commit a775fe5
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/src/plugins/documenter.jl b/src/plugins/documenter.jl
@@ -37,6 +37,15 @@ Sets up documentation generation via [Documenter.jl](https://github.com/JuliaDoc
 Documentation deployment depends on `T`, where `T` is some supported CI plugin,
 or `Nothing` to only support local documentation builds.
 
+!!! note
+    If you are deploying documentation with GitHub Actions or Travis CI, don't forget to complete
+    [the required configuration](https://documenter.juliadocs.org/stable/man/hosting/#Hosting-Documentation).
+    In particular, you may need to run
+    ```julia
+    using DocumenterTools; DocumenterTools.genkeys(user="MyUser", repo="MyPackage.jl")
+    ```
+    and follow the instructions there.
+
 ## Supported Type Parameters
 - `GitHubActions`: Deploys documentation to [GitHub Pages](https://pages.github.com)
   with the help of [`GitHubActions`](@ref).
@@ -62,10 +71,6 @@ or `Nothing` to only support local documentation builds.
 - `devbranch::Union{AbstractString, Nothing}`: Branch that will trigger docs deployment.
   If `nothing`, then the default branch according to the `Template` will be used.
 - `makedocs_kwargs::Dict{Symbol,Any}`: Extra keyword arguments to be inserted into `makedocs`.
-
-!!! note
-    If deploying documentation with Travis CI, don't forget to complete
-    [the required configuration](https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#SSH-Deploy-Keys-1).
 """
 struct Documenter{T} <: Plugin
     assets::Vector{String}

diff --git a/templates/github/workflows/CI.yml b/templates/github/workflows/CI.yml
@@ -92,6 +92,7 @@ jobs:
       - uses: julia-actions/julia-docdeploy@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
       - name: Run doctests
         shell: julia --project=docs --color=yes {0}
         run: |

diff --git a/test/fixtures/DocumenterGitHubActions/.github/workflows/CI.yml b/test/fixtures/DocumenterGitHubActions/.github/workflows/CI.yml
@@ -62,6 +62,7 @@ jobs:
       - uses: julia-actions/julia-docdeploy@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
       - name: Run doctests
         shell: julia --project=docs --color=yes {0}
         run: |

diff --git a/test/fixtures/WackyOptions/.github/workflows/CI.yml b/test/fixtures/WackyOptions/.github/workflows/CI.yml
@@ -63,6 +63,7 @@ jobs:
       - uses: julia-actions/julia-docdeploy@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
       - name: Run doctests
         shell: julia --project=docs --color=yes {0}
         run: |