From 49d4fb07ecf2955f4a06ad17bf94d7ffc6cfedf1 Mon Sep 17 00:00:00 2001 From: David Maas Date: Thu, 2 Jan 2025 05:40:31 -0600 Subject: [PATCH] Fix unnecessary GitHub Actions version specificity and update to modern GitHub Pages deployment --- .github/workflows/docs.yml | 41 +++++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9e0c786..a80fb6c 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,21 +1,30 @@ -# Builds and publishes the documentation website to gh-pages branch +# Builds and publishes the documentation website name: Build docs on: workflow_dispatch: +concurrency: + group: docs + cancel-in-progress: true + +permissions: + # Both required by actions/deploy-pages + pages: write + id-token: write + jobs: build: runs-on: windows-latest steps: - name: Checkout - uses: actions/checkout@v4.1.1 + uses: actions/checkout@v4 with: submodules: true - + - name: Setup MSBuild uses: microsoft/setup-msbuild@v2 - + - name: Restore NuGet Packages run: msbuild -t:restore src/Bonsai.Scripting.Python.sln @@ -23,29 +32,25 @@ jobs: run: msbuild src/Bonsai.Scripting.Python.sln /p:Configuration=Release - name: Setup .NET Core SDK - uses: actions/setup-dotnet@v4.0.0 + uses: actions/setup-dotnet@v4 with: dotnet-version: 7.x - + - name: Setup DocFX run: dotnet tool restore - name: Setup Bonsai working-directory: .bonsai run: .\Setup.ps1 - + - name: Build Documentation working-directory: docs run: .\build.ps1 - - - name: Checkout gh-pages - uses: actions/checkout@v4.1.1 - with: - ref: gh-pages - path: gh-pages - - name: Publish to github pages - uses: peaceiris/actions-gh-pages@v3.9.3 + + - name: Upload GitHub Pages Artifact + uses: actions/upload-pages-artifact@v3 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: docs/_site - force_orphan: true \ No newline at end of file + path: docs/_site + + - name: Deploy to GitHub Pages + uses: actions/deploy-pages@v4