[CI] Rework docs deployment (#77)

* [CI] Rework docs deployment

* [CI] Upload documentation build as an artifact

* [docs] Push documentation to BreezeDocumentation

* [CI] Use BreezeDocumentation Documenter key

* [CI] Don't create token for PRs from forks

* [docs] Only push previews when all env vars are non-empty

* [CI] Don't use app to generate github token

* Update link to documentation in README.md

Author: giordano

.github/workflows/Documentation.yml

@@ -51,7 +51,7 @@ jobs:
       - uses: julia-actions/julia-docdeploy@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+          DOCUMENTER_KEY: ${{ secrets.BREEZEDOCUMENTATION_DOCUMENTER_KEY }}
       - name: Save Julia depot cache on cancel or failure
         id: julia-cache-save
         if: cancelled() || failure()
@@ -60,3 +60,8 @@ jobs:
           path: |
             ${{ steps.julia-cache.outputs.cache-paths }}
           key: ${{ steps.julia-cache.outputs.cache-key }}
+      - uses: actions/upload-artifact@v4
+        with:
+          name: documentation-build
+          path: docs/build
+          retention-days: 7

README.md

@@ -5,11 +5,11 @@
 
 <!-- description -->
 <p align="center">
-  <strong>🌪 Fast and friendly Julia software for atmosphere simulations on CPUs and GPUs. https://numericalearth.github.io/Breeze.jl/dev/</strong>
+  <strong>🌪 Fast and friendly Julia software for atmosphere simulations on CPUs and GPUs. https://numericalearth.github.io/BreezeDocumentation/dev/</strong>
 </p>
 
 <p align="center">
-    <a href="https://numericalearth.github.io/Breeze.jl/dev/">
+    <a href="https://numericalearth.github.io/BreezeDocumentation/dev/">
     <img alt="Documentation" src="https://img.shields.io/badge/documentation-in%20development-orange?style=flat-square">
     </a>
     <a href="https://github.com/NumericalEarth/Breeze.jl/discussions">

docs/make.jl

@@ -29,9 +29,13 @@ makedocs(sitename="Breeze",
     ]
 )
 
-deploydocs(;
+deploydocs(
+    ;
     repo = "github.com/NumericalEarth/Breeze.jl",
+    deploy_repo = "github.com/NumericalEarth/BreezeDocumentation",
     devbranch = "main",
-    push_preview = true,
-    forcepush = true
+    # Only push previews if all the relevant environment variables are non-empty. This is an
+    # attempt to work around https://github.com/JuliaDocs/Documenter.jl/issues/2048.
+    push_preview = all(!isempty, (get(ENV, "GITHUB_TOKEN", ""), get(ENV, "DOCUMENTER_KEY", ""))),
+    forcepush = true,
 )