From 1864fa745f2fe9b2902a67a9a793111a921307b1 Mon Sep 17 00:00:00 2001 From: David Widmann Date: Mon, 11 Mar 2024 00:21:28 +0100 Subject: [PATCH 1/3] Update Documenter to version 1 --- .github/dependabot.yml | 7 +++++++ .github/workflows/Docs.yml | 4 +++- docs/Project.toml | 2 +- docs/make.jl | 1 - 4 files changed, 11 insertions(+), 3 deletions(-) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..d60f070 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" # Location of package manifests + schedule: + interval: "monthly" diff --git a/.github/workflows/Docs.yml b/.github/workflows/Docs.yml index 68c5eb0..5e29679 100644 --- a/.github/workflows/Docs.yml +++ b/.github/workflows/Docs.yml @@ -9,6 +9,9 @@ on: jobs: docs: + permissions: + contents: write + statuses: write name: Documentation runs-on: ubuntu-latest steps: @@ -24,4 +27,3 @@ jobs: - run: julia --project=docs docs/make.jl env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} diff --git a/docs/Project.toml b/docs/Project.toml index 0db04f8..4c1e5ea 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -8,5 +8,5 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" AbstractGPs = "0.3, 0.4, 0.5" AbstractGPsMakie = "0.2" CairoMakie = "0.6, 0.7, 0.8, 0.9, 0.10" -Documenter = "0.27" +Documenter = "1" julia = "1.3" diff --git a/docs/make.jl b/docs/make.jl index 6ef9dac..63be2ce 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -22,7 +22,6 @@ makedocs(; assets=String[], ), pages=["Home" => "index.md", "api.md"], - #strict=true, checkdocs=:exports, ) From 4eafce8ad46b91043b6c27f8c4f83c5d7be4859f Mon Sep 17 00:00:00 2001 From: David Widmann Date: Mon, 11 Mar 2024 00:30:08 +0100 Subject: [PATCH 2/3] Add missing docs --- docs/src/api.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/api.md b/docs/src/api.md index c300a79..724e2ec 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -4,6 +4,7 @@ ```@docs symband +symband! ``` ### Example @@ -27,6 +28,7 @@ save("symband_example.svg", current_figure()); nothing # hide ```@docs gpsample +gpsample! gpsample(::AbstractVector, ::AbstractGPsMakie.AbstractGP) ``` From 098e636e1b1cbe6e7300ab23fe7378ffa10622a4 Mon Sep 17 00:00:00 2001 From: David Widmann Date: Mon, 11 Mar 2024 00:49:11 +0100 Subject: [PATCH 3/3] Update cleanup action --- .github/workflows/DocsPreviewCleanup.yml | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/.github/workflows/DocsPreviewCleanup.yml b/.github/workflows/DocsPreviewCleanup.yml index 4f57bc4..66e9197 100644 --- a/.github/workflows/DocsPreviewCleanup.yml +++ b/.github/workflows/DocsPreviewCleanup.yml @@ -4,9 +4,16 @@ on: pull_request: types: [closed] +# Ensure that only one "DocsPreviewCleanup" workflow is force pushing at a time +concurrency: + group: docs-preview-cleanup + cancel-in-progress: false + jobs: - cleanup: + docs-preview-cleanup: runs-on: ubuntu-latest + permissions: + contents: write steps: - name: Checkout gh-pages branch uses: actions/checkout@v2 @@ -14,13 +21,13 @@ jobs: ref: gh-pages - name: Delete preview and history + push changes run: | - if [ -d "previews/PR$PRNUM" ]; then + if [ -d "${preview_dir}" ]; then git config user.name "Documenter.jl" git config user.email "documenter@juliadocs.github.io" - git rm -rf "previews/PR$PRNUM" + git rm -rf "${preview_dir}" git commit -m "delete preview" git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree}) git push --force origin gh-pages-new:gh-pages - fi + fi env: - PRNUM: ${{ github.event.number }} + preview_dir: previews/PR${{ github.event.number }}