diff --git a/.github/workflows/common-setup.yml b/.github/workflows/common-setup.yml index 39a95d1c2..7724867ce 100644 --- a/.github/workflows/common-setup.yml +++ b/.github/workflows/common-setup.yml @@ -1,5 +1,6 @@ name: Common Setup for Stride Documentation +# This is not used currently. The job runs in a separate instants so can't be used on: workflow_call: outputs: @@ -8,7 +9,7 @@ on: value: ${{ jobs.setup.outputs.stride_docs_path }} stride_path: description: "The checkout path of the Stride repository" - value: ${{ jobs.setup.outputs.stride_path }} + value: ${{ jobs.setup.outputs.stride_path }} jobs: setup: diff --git a/.github/workflows/stride-docs-staging-azure.yml b/.github/workflows/stride-docs-staging-azure.yml index 172e012ec..7fe8d22b1 100644 --- a/.github/workflows/stride-docs-staging-azure.yml +++ b/.github/workflows/stride-docs-staging-azure.yml @@ -3,6 +3,11 @@ name: Build Stride Docs for Azure Web App Staging +env: + COMMON_SETTINGS_PATH: en/docfx.json + VERSION: "2.0.0.${{ github.run_number }}" + DOCS_PATH: stride-docs + on: push: branches: @@ -17,25 +22,60 @@ on: workflow_dispatch: jobs: - setup: - uses: ./.github/workflows/common-setup.yml - build: - needs: setup - runs-on: windows-2022 # Run this job only if the repository is 'stride3d/stride-docs' if: github.repository == 'stride3d/stride-docs' + runs-on: windows-2022 + steps: - - name: List Contents of Stride Docs Path - run: dir - working-directory: ${{ needs.setup.outputs.stride_docs_path }} - + - name: .NET SDK Setup + uses: actions/setup-dotnet@v4 + with: + dotnet-version: 8.x + + # Checkout the Stride Docs repository from the branch that triggered the workflow + - name: Checkout Stride Docs + uses: actions/checkout@v4 + with: + path: ${{ env.DOCS_PATH }} + lfs: true + + - name: Set Version in docfx.json + run: | + $settingsContent = Get-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Raw + $updatedDocFxJsonContent = $settingsContent -replace '2.0.0.x', "${{ env.VERSION }}" + Set-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Value $updatedDocFxJsonContent + shell: pwsh + + - name: Display Updated docfx.json + run: cat "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" + shell: pwsh + + - name: Fail the Workflow + run: exit 1 + shell: pwsh + + # Checkout the Stride repository from the default branch + - name: Checkout Stride (note the LFS) + uses: actions/checkout@v4 + with: + repository: stride3d/stride + token: ${{ secrets.GITHUB_TOKEN }} + path: stride + lfs: true + + - name: Install DocFX + # This installs the latest version of DocFX and may introduce breaking changes + # run: dotnet tool update -g docfx + # This installs a specific, tested version of DocFX. + run: dotnet tool update -g docfx --version 2.76.0 + - name: Build documentation run: ./build-all.bat - working-directory: ${{ needs.setup.outputs.stride_docs_path }} + working-directory: ${{ env.DOCS_PATH }} - name: Compress artifact - run: 7z a -r DocFX-app.zip ./${{ needs.setup.outputs.stride_docs_path }}/_site/* + run: 7z a -r DocFX-app.zip ./${{ env.DOCS_PATH }}/_site/* - name: Upload artifact for deployment job uses: actions/upload-artifact@v4 @@ -47,7 +87,7 @@ jobs: if: github.repository == 'stride3d/stride-docs' runs-on: windows-2022 - needs: [build, setup] + needs: build environment: name: 'Production' url: ${{ steps.deploy-to-webapp.outputs.webapp-url }} @@ -62,7 +102,7 @@ jobs: # run: ls - name: Decompress artifact - run: 7z x DocFX-app.zip "-o./stride-docs/_site" + run: 7z x DocFX-app.zip "-o./${{ env.DOCS_PATH }}/_site" - name: Deploy to Azure Web App id: deploy-to-webapp @@ -71,4 +111,4 @@ jobs: app-name: 'stride-doc' slot-name: 'staging' publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_32FCD402B970463A9143B24C9B225749 }} - package: ./stride-docs/_site + package: ./${{ env.DOCS_PATH }}/_site \ No newline at end of file diff --git a/en/docfx.json b/en/docfx.json index df5a329be..9ebb7b181 100644 --- a/en/docfx.json +++ b/en/docfx.json @@ -58,7 +58,7 @@ "_enableSearch": true, "_appLogoPath": "media/stride-logo-red.svg", "_appLogoUrl": "https://www.stride3d.net/", - "_appFooter": "
Supported by the .NET Foundation
Made with docfx
Stride Docs Website v.2.0.0.12
© .NET Foundation and Contributors
Supported by the .NET Foundation
Made with docfx
Stride Docs Website v.2.0.0.x
© .NET Foundation and Contributors