Fix API docs (#310)

auth0 · Dec 18, 2023 · c5c977f · c5c977f
1 parent 487646f
commit c5c977f
Show file tree

Hide file tree

Showing 12 changed files with 51 additions and 23 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -48,19 +48,9 @@ jobs:
       - name: Build
         run: msbuild Auth0.OidcClient.All.sln -t:rebuild -verbosity:diag -property:Configuration=Release
 
-      - name: NuGet pack
-        run: |
-          nuget pack nuget/Auth0.OidcClient.Android.nuspec
-          nuget pack nuget/Auth0.OidcClient.AndroidX.nuspec
-          nuget pack nuget/Auth0.OidcClient.Core.nuspec
-          nuget pack nuget/Auth0.OidcClient.iOS.nuspec
-          nuget pack nuget/Auth0.OidcClient.UWP.nuspec
-          nuget pack nuget/Auth0.OidcClient.WinForms.nuspec
-          nuget pack nuget/Auth0.OidcClient.WPF.nuspec
-
       - name: Install DocFX
         run: dotnet tool install -g docfx
-      
+
       - name: Build docs
         run: ./tools/build-docs.sh
         shell: bash
@@ -69,6 +59,16 @@ jobs:
         with:
           name: docs
           path: docs
+
+      - name: NuGet pack
+        run: |
+          nuget pack nuget/Auth0.OidcClient.Android.nuspec
+          nuget pack nuget/Auth0.OidcClient.AndroidX.nuspec
+          nuget pack nuget/Auth0.OidcClient.Core.nuspec
+          nuget pack nuget/Auth0.OidcClient.iOS.nuspec
+          nuget pack nuget/Auth0.OidcClient.UWP.nuspec
+          nuget pack nuget/Auth0.OidcClient.WinForms.nuspec
+          nuget pack nuget/Auth0.OidcClient.WPF.nuspec
 
       - uses: actions/upload-artifact@v3
         with:
@@ -80,5 +80,28 @@ jobs:
         env:
           NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
 
+  # Deploy job
+  deploy-docs:
+    # Add a dependency to publish-nuget job
+    needs: publish-nuget
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v3 # or specific "vX.X.X" version tag for this action
+        with:
+          artifact_name: docs
 
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -7,3 +7,8 @@ When contributing to this SDK, please:
 - Maintain the existing minumum .NET framework/core support.
 - Keep PRs focused and change the minimum number of lines to achieve your goal.
 - Do not introduce breaking changes without prior discussion and approval.
+
+
+### API documentation
+
+As the API documentation requires a windows environment, it is built and deployed automatically when running the release GitHub Actions workflow.
diff --git a/src/Auth0.OidcClient.Android/docs-source/docfx.json b/src/Auth0.OidcClient.Android/docs-source/docfx.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",
@@ -26,7 +26,7 @@
               "bin/Release/**/mscorlib.dll",
               "bin/Release/**/System*.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ]
 

diff --git a/src/Auth0.OidcClient.Android/docs-source/docfx.local.json b/src/Auth0.OidcClient.Android/docs-source/docfx.local.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",
@@ -26,7 +26,7 @@
               "bin/Release/**/mscorlib.dll",
               "bin/Release/**/System*.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ]
 

diff --git a/src/Auth0.OidcClient.UWP/docs-source/docfx.json b/src/Auth0.OidcClient.UWP/docs-source/docfx.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.UWP/docs-source/docfx.local.json b/src/Auth0.OidcClient.UWP/docs-source/docfx.local.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.WPF/docs-source/docfx.json b/src/Auth0.OidcClient.WPF/docs-source/docfx.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.WPF/docs-source/docfx.local.json b/src/Auth0.OidcClient.WPF/docs-source/docfx.local.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.WinForms/docs-source/docfx.json b/src/Auth0.OidcClient.WinForms/docs-source/docfx.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.WinForms/docs-source/docfx.local.json b/src/Auth0.OidcClient.WinForms/docs-source/docfx.local.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.iOS/docs-source/docfx.json b/src/Auth0.OidcClient.iOS/docs-source/docfx.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.iOS/docs-source/docfx.local.json b/src/Auth0.OidcClient.iOS/docs-source/docfx.local.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",