Bläddra i källkod

feat: Comments added and DocFX version bumped

Vaclav Elias 2 år sedan
förälder
incheckning
7115710ee5

+ 7 - 3
.github/workflows/stride-docs-release-azure.yml

@@ -18,21 +18,25 @@ on:
 
 jobs:
   build:
+    # Run this job only if the repository is 'stride3d/stride-docs'
     if: github.repository == 'stride3d/stride-docs'
     runs-on: windows-2022
 
     steps:
+    # Setup .NET SDK
     - name: Dotnet Setup
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: 6.x
 
+    # Checkout the Stride Docs repository from the branch that triggered the workflow
     - name: Checkout Stride Docs
       uses: actions/checkout@v3
       with:
         path: stride-docs
         lfs: true
 
+    # Checkout the Stride repository from the default branch
     - name: Checkout Stride (note the LFS)
       uses: actions/checkout@v3
       with:
@@ -42,10 +46,10 @@ jobs:
         lfs: true
 
     - name: Install DocFX
-      # This installs the latest version of DocFX and may introduce breaking changes.
+      # 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.70.3
+      run: dotnet tool update -g docfx --version 2.70.4
 
     - name: Build documentation
       run: ./build-all.bat
@@ -87,4 +91,4 @@ jobs:
           app-name: 'stride-doc'
           slot-name: 'Production'
           publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_4803638D673FA67D0C8650F34C4FA9D1 }}
-          package: ./stride-docs/_site
+          package: ./stride-docs/_site

+ 6 - 2
.github/workflows/stride-docs-staging-azure.yml

@@ -18,21 +18,25 @@ on:
 
 jobs:
   build:
+    # Run this job only if the repository is 'stride3d/stride-docs'
     if: github.repository == 'stride3d/stride-docs'
     runs-on: windows-2022
 
     steps:
+    # Setup .NET SDK
     - name: Dotnet Setup
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: 6.x
 
+    # Checkout the Stride Docs repository from the branch that triggered the workflow
     - name: Checkout Stride Docs
       uses: actions/checkout@v3
       with:
         path: stride-docs
         lfs: true
 
+    # Checkout the Stride repository from the default branch
     - name: Checkout Stride (note the LFS)
       uses: actions/checkout@v3
       with:
@@ -45,7 +49,7 @@ jobs:
       # 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.70.3
+      run: dotnet tool update -g docfx --version 2.70.4
 
     - name: Build documentation
       run: ./build-all.bat
@@ -87,4 +91,4 @@ jobs:
           app-name: 'stride-doc'
           slot-name: 'staging'
           publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_32FCD402B970463A9143B24C9B225749 }}
-          package: ./stride-docs/_site
+          package: ./stride-docs/_site

+ 8 - 13
.github/workflows/stride-docs-staging-fast-track-azure.yml

@@ -1,40 +1,35 @@
 # Docs for the Azure Web Apps Deploy action: https://github.com/Azure/webapps-deploy
 # More GitHub Actions for Azure: https://github.com/Azure/actions
 
+# The Fast Track skips creating artifacts and compressing them
 name: Build Stride Docs (Fast Track) for Azure Web App Staging
 
 on:
-  # push:
-  #   branches:
-  #     - staging
-  #   paths-ignore:
-  #     - 'README.md'
-  #     - 'Stride.Docs.sln'
-  #     - 'BuildDocs.ps1'
-  #     - 'wiki/**'
-  #     - .gitignore
-  #     - '.github/**'
   workflow_dispatch:
 
 jobs:
   build-deploy:
+    # Run this job only if the repository is 'stride3d/stride-docs'
     if: github.repository == 'stride3d/stride-docs'
     runs-on: windows-2022
     environment:
       name: 'Production'
 
     steps:
+    # Setup .NET SDK
     - name: Dotnet Setup
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: 6.x
 
+    # Checkout the Stride Docs repository from the branch that triggered the workflow
     - name: Checkout Stride Docs
       uses: actions/checkout@v3
       with:
         path: stride-docs
         lfs: true
 
+    # Checkout the Stride repository from the default branch
     - name: Checkout Stride (note the LFS)
       uses: actions/checkout@v3
       with:
@@ -44,10 +39,10 @@ jobs:
         lfs: true
 
     - name: Install DocFX
-      # This installs the latest version of DocFX and may introduce breaking changes.
+      # 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.70.3
+      run: dotnet tool update -g docfx --version 2.70.4
 
     - name: Build documentation
       run: ./build-all.bat
@@ -60,4 +55,4 @@ jobs:
           app-name: 'stride-doc'
           slot-name: 'staging'
           publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_32FCD402B970463A9143B24C9B225749 }}
-          package: ./stride-docs/_site
+          package: ./stride-docs/_site

+ 1 - 0
.github/workflows/stride-docs-wiki.yml

@@ -9,6 +9,7 @@ on:
 
 jobs:
   build:
+    # Run this job only if the repository is 'stride3d/stride-docs'
     if: github.repository == 'stride3d/stride-docs'
     runs-on: ubuntu-latest