chore(ci): api docs build update (#188)

* chore(deps): updates sample deps

* chore(ci): updated bug report template

* chore(ci): updated api docs implementation

* chore(ci): changing trigger to run manually

* chore(ci): updating api docs build

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Setup .NET 6.0
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@607fce577a46308457984d59e4954e075820f10a
         with:
           dotnet-version: 6.0.302
       - name: Install solution dependencies

.github/workflows/docs.yml

@@ -13,7 +13,7 @@ jobs:
       group: on-docs-build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c
         with:
           fetch-depth: 0
       - name: Set up Python
@@ -28,7 +28,7 @@ jobs:
       - name: Build docs website
         run: make build-docs-website
       - name: Deploy all docs
-        uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0
+        uses: peaceiris/actions-gh-pages@bd8c6b06eba6b3d25d72b7a1767993c0aeee42e7 # v3.9.2
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./dist
@@ -37,17 +37,21 @@ jobs:
     # This is to prevent "race-condition" in publishing a new version of doc to `gh-pages`
     concurrency:
       group: on-docs-build
-    runs-on: macos-latest
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - name: Setup .NET 6.0
+        uses: actions/setup-dotnet@607fce577a46308457984d59e4954e075820f10a
         with:
-          fetch-depth: 0
-      - name: Configure and build api docs generator
+          dotnet-version: 6.0.302
+      - name: Install solution dependencies
+        run: |
+          dotnet tool install -g docfx
+      - name: Create API docs
         run: |
-          brew install -f docfx --skip-cask-deps --ignore-dependencies
           docfx apidocs/docfx.json
       - name: Release API docs to latest
-        uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0
+        uses: peaceiris/actions-gh-pages@bd8c6b06eba6b3d25d72b7a1767993c0aeee42e7 # v3.9.2
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./apidocs/_site

apidocs/docfx.json

@@ -11,6 +11,9 @@
         }
       ],
       "dest": "api",
+      "properties": {
+        "TargetFramework": "net6.0"
+      },
       "disableGitFeatures": false,
       "disableDefaultFilter": false
     }
@@ -46,7 +49,7 @@
       "_enableNewTab": true,
       "_disableContribution": true,
       "_enableSearch": "true",
-      "_appFooter": "AWS Lambda Powertools for .NET"
+      "_appFooter": "AWS Lambda Powertools for .NET API Documentation"
     },
     "fileMetadataFiles": [],
     "template": ["default", "templates/material"],

apidocs/index.md

@@ -1,8 +1,8 @@
 # AWS Lambda Powertools for .NET API
 
-Welcome to the *AWS Lambda Powertools for .NET* API reference. This documentation contains the API details for all supported utilities.
+Welcome to the **AWS Lambda Powertools for .NET API** reference. This documentation contains the API details for all supported utilities.
 
-To get started use the `API` menu on the navigation bar, or search for specific keywords on the search box on top-right corner of your screen.
+To get started use the `API Documentaion` menu on the navigation bar, or search for specific keywords on the search box on top-right corner of your screen.
 
 > [!NOTE]
 > Are you looking for documentation on how to use AWS Lambda Powertools for .NET utilities and code samples?

apidocs/toc.yml

@@ -1,3 +1,5 @@
-- name: API
+- name: API Documentation
   href: api/
   homepage: api/index.md
+- name: AWS Lambda Powertools for .NET Documentation
+  href: "https://awslabs.github.io/aws-lambda-powertools-dotnet/"