diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml index cde1711..848cd7b 100644 --- a/.github/workflows/Documentation.yml +++ b/.github/workflows/Documentation.yml @@ -10,22 +10,31 @@ on: jobs: build: + permissions: + actions: write + contents: write + pull-requests: read + statuses: write runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: julia-actions/setup-julia@latest with: version: '1' + - name: "Start SSH agent" + uses: "webfactory/ssh-agent@d4b9b8ff72958532804b70bbe600ad43b36d5f2e" # v0.8.0 + with: + ssh-private-key: "${{ secrets.DOCUMENTER_KEY }}" - name: Install dependencies - run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' + run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(url="git@github.com:Neuroblox/Neuroblox.jl.git")); Pkg.instantiate()' - name: Build 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 + DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY_DEPLOY }} # For authentication with SSH deploy key run: julia --project=docs/ --code-coverage=user docs/make.jl - uses: julia-actions/julia-processcoverage@v1 with: directories: src - - uses: codecov/codecov-action@v3 + - uses: codecov/codecov-action@v4 with: files: lcov.info diff --git a/Project.toml b/Project.toml new file mode 100644 index 0000000..06f37cf --- /dev/null +++ b/Project.toml @@ -0,0 +1,2 @@ +name = "NeurobloxDocsHost" +uuid = "1bb98921-23b1-4067-a5f0-d1e925508412" diff --git a/docs/make.jl b/docs/make.jl index 1662eba..c4111ae 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,11 +1,11 @@ using Neuroblox using Documenter +DocMeta.setdocmeta!(Neuroblox, :DocTestSetup, :(using Neuroblox); recursive = true) + cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true) cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true) -DocMeta.setdocmeta!(Neuroblox, :DocTestSetup, :(using Neuroblox); recursive = true) - include("pages.jl") makedocs(sitename = "Neuroblox", @@ -14,10 +14,9 @@ makedocs(sitename = "Neuroblox", clean = true, doctest = false, linkcheck = true, warnonly = [:docs_block, :missing_docs], format = Documenter.HTML(assets = ["assets/favicon.ico"]), - #canonical = "https://docs.sciml.ai/LinearSolve/stable/"), pages = pages) -repo = "github.com/Neuroblox/NeurobloxDocsHost" +repo = "github.com/Neuroblox/NeurobloxDocsHost.git" withenv("GITHUB_REPOSITORY" => repo) do deploydocs(; repo = repo, push_preview = true) diff --git a/src/NeurobloxDocsHost.jl b/src/NeurobloxDocsHost.jl new file mode 100644 index 0000000..0e7b5ed --- /dev/null +++ b/src/NeurobloxDocsHost.jl @@ -0,0 +1,3 @@ +module NeurobloxDocsHost + +end \ No newline at end of file