From f6c3b4beda219b2a76d533ee474e6a5d4d0a6bb4 Mon Sep 17 00:00:00 2001 From: Tristan Nixon Date: Mon, 17 Apr 2023 10:17:59 -0700 Subject: [PATCH 1/5] Need to mark the github workspace as "safe" for the Sphinx build to work correctly --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0ed66109..37cbeed9 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -20,6 +20,7 @@ jobs: uses: actions/checkout@v3 with: fetch-depth: '0' + set-safe-directory: $GITHUB_WORKSPACE - name: Copy Requirements uses: canastro/copy-file-action@master with: From 7970fa5a0925119c570a9e40ad15f819487bcdad Mon Sep 17 00:00:00 2001 From: Tristan Nixon Date: Mon, 17 Apr 2023 10:25:20 -0700 Subject: [PATCH 2/5] Test docs build without deploying --- .github/workflows/docs.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 37cbeed9..a7179ee4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -35,9 +35,9 @@ jobs: with: name: html-docs path: docs/_build/html/ - - name: Deploy 🚀 - uses: peaceiris/actions-gh-pages@v3 - if: $${{ github.ref }} == 'refs/heads/master' - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: docs/_build/html +# - name: Deploy 🚀 +# uses: peaceiris/actions-gh-pages@v3 +# if: $${{ github.ref }} == 'refs/heads/master' +# with: +# github_token: ${{ secrets.GITHUB_TOKEN }} +# publish_dir: docs/_build/html From ece06a8e221b632561548d2dafb44cce8a92c806 Mon Sep 17 00:00:00 2001 From: Tristan Nixon Date: Mon, 17 Apr 2023 10:50:46 -0700 Subject: [PATCH 3/5] Test docs build without deploying --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a7179ee4..24f00ec0 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,6 +5,7 @@ on: push: tags: - 'v*' # only release a versioned tag, such as v.X.Y.Z + branches: ['*'] jobs: build-docs: From f87c7724e4689b817bf556b1cbd94acc4f8d33d2 Mon Sep 17 00:00:00 2001 From: Tristan Nixon Date: Mon, 17 Apr 2023 10:58:12 -0700 Subject: [PATCH 4/5] trying to mark workspace as "safe" --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 24f00ec0..7d634ce2 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -30,7 +30,7 @@ jobs: - name: Build HTML uses: ammaraskar/sphinx-action@0.4 with: - pre-build-command: "apt-get update -y && apt-get install -y git" + pre-build-command: "apt-get update -y && apt-get install -y git && git config --global --add safe.directory /github/workspace" - name: Upload artifacts uses: actions/upload-artifact@v1 with: From a7d5da95e8b823671e3788c28a4e2f7aad19740b Mon Sep 17 00:00:00 2001 From: Tristan Nixon Date: Mon, 17 Apr 2023 11:02:57 -0700 Subject: [PATCH 5/5] removing test conditions --- .github/workflows/docs.yml | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 7d634ce2..a4158c26 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,7 +5,6 @@ on: push: tags: - 'v*' # only release a versioned tag, such as v.X.Y.Z - branches: ['*'] jobs: build-docs: @@ -21,7 +20,6 @@ jobs: uses: actions/checkout@v3 with: fetch-depth: '0' - set-safe-directory: $GITHUB_WORKSPACE - name: Copy Requirements uses: canastro/copy-file-action@master with: @@ -36,9 +34,9 @@ jobs: with: name: html-docs path: docs/_build/html/ -# - name: Deploy 🚀 -# uses: peaceiris/actions-gh-pages@v3 -# if: $${{ github.ref }} == 'refs/heads/master' -# with: -# github_token: ${{ secrets.GITHUB_TOKEN }} -# publish_dir: docs/_build/html + - name: Deploy 🚀 + uses: peaceiris/actions-gh-pages@v3 + if: $${{ github.ref }} == 'refs/heads/master' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/_build/html