attempt to set up actions

Author: lkdvos

.github/workflows/Documentation.yml

@@ -0,0 +1,31 @@
+name: Documentation
+
+permissions:
+  contents: write
+  pages: write
+
+on:
+  push:
+    branches:
+      - main
+  schedule:
+    - cron: '0 0 * * *'
+  workflow_dispatch:
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(path="."); Pkg.instantiate()'
+
+      - name: Aggregate and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
+        run: julia --project=docs docs/make.jl

docs/make.jl

@@ -67,39 +67,4 @@ MultiDocumenter.make(
     sitemap = true,
 )
 
-if "deploy" in ARGS
-    @warn "Deploying to GitHub" ARGS
-    gitroot = normpath(joinpath(@__DIR__, ".."))
-    run(`git pull`)
-    outbranch = "gh-pages"
-    has_outbranch = true
-    if !success(`git checkout $outbranch`)
-        has_outbranch = false
-        if !success(`git switch --orphan $outbranch`)
-            @error "Cannot create new orphaned branch $outbranch."
-            exit(1)
-        end
-    end
-    for file in readdir(gitroot; join = true)
-        endswith(file, ".git") && continue
-        rm(file; force = true, recursive = true)
-    end
-    for file in readdir(outpath)
-        cp(joinpath(outpath, file), joinpath(gitroot, file))
-    end
-    run(`git add .`)
-    if success(`git commit -m 'Aggregate documentation'`)
-        @info "Pushing updated documentation."
-        if has_outbranch
-            run(`git push`)
-        else
-            run(`git push -u origin $outbranch`)
-        end
-        run(`git checkout main`)
-    else
-        @info "No changes to aggregated documentation."
-    end
-else
-    # @info "Skipping deployment, 'deploy' not passed. Generated files in docs/out." ARGS
-    # cp(outpath, joinpath(@__DIR__, "out"), force = true)
-end
+Documenter.deploydocs(; repo = "github.com/QuantumKitHub/QuantumKitHubDocs.jl.git", push_preview = true)