Skip to content

Commit 2adaac6

Browse files
committed
Merge branch 'develop'
2 parents f5b4456 + 973d67c commit 2adaac6

File tree

5 files changed

+25
-16
lines changed

5 files changed

+25
-16
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
steps:
1818
- uses: actions/checkout@v3
1919
- name: Setup .NET 6.0
20-
uses: actions/setup-dotnet@v3
20+
uses: actions/setup-dotnet@607fce577a46308457984d59e4954e075820f10a
2121
with:
2222
dotnet-version: 6.0.302
2323
- name: Install solution dependencies

.github/workflows/docs.yml

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
name: Docs
22

3-
on:
4-
push:
5-
branches:
6-
- main
3+
on: workflow_dispatch
4+
# push:
5+
# branches:
6+
# - main
77

88
jobs:
99
docs:
@@ -13,7 +13,7 @@ jobs:
1313
group: on-docs-build
1414
runs-on: ubuntu-latest
1515
steps:
16-
- uses: actions/checkout@v3
16+
- uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c
1717
with:
1818
fetch-depth: 0
1919
- name: Set up Python
@@ -28,7 +28,7 @@ jobs:
2828
- name: Build docs website
2929
run: make build-docs-website
3030
- name: Deploy all docs
31-
uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0
31+
uses: peaceiris/actions-gh-pages@bd8c6b06eba6b3d25d72b7a1767993c0aeee42e7 # v3.9.2
3232
with:
3333
github_token: ${{ secrets.GITHUB_TOKEN }}
3434
publish_dir: ./dist
@@ -37,17 +37,21 @@ jobs:
3737
# This is to prevent "race-condition" in publishing a new version of doc to `gh-pages`
3838
concurrency:
3939
group: on-docs-build
40-
runs-on: macos-latest
40+
runs-on: ubuntu-latest
4141
steps:
4242
- uses: actions/checkout@v3
43+
- name: Setup .NET 6.0
44+
uses: actions/setup-dotnet@607fce577a46308457984d59e4954e075820f10a
4345
with:
44-
fetch-depth: 0
45-
- name: Configure and build api docs generator
46+
dotnet-version: 6.0.302
47+
- name: Install solution dependencies
48+
run: |
49+
dotnet tool install -g docfx
50+
- name: Create API docs
4651
run: |
47-
brew install -f docfx --skip-cask-deps --ignore-dependencies
4852
docfx apidocs/docfx.json
4953
- name: Release API docs to latest
50-
uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0
54+
uses: peaceiris/actions-gh-pages@bd8c6b06eba6b3d25d72b7a1767993c0aeee42e7 # v3.9.2
5155
with:
5256
github_token: ${{ secrets.GITHUB_TOKEN }}
5357
publish_dir: ./apidocs/_site

apidocs/docfx.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
}
1212
],
1313
"dest": "api",
14+
"properties": {
15+
"TargetFramework": "net6.0"
16+
},
1417
"disableGitFeatures": false,
1518
"disableDefaultFilter": false
1619
}
@@ -46,7 +49,7 @@
4649
"_enableNewTab": true,
4750
"_disableContribution": true,
4851
"_enableSearch": "true",
49-
"_appFooter": "AWS Lambda Powertools for .NET"
52+
"_appFooter": "AWS Lambda Powertools for .NET API Documentation"
5053
},
5154
"fileMetadataFiles": [],
5255
"template": ["default", "templates/material"],

apidocs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# AWS Lambda Powertools for .NET API
22

3-
Welcome to the *AWS Lambda Powertools for .NET* API reference. This documentation contains the API details for all supported utilities.
3+
Welcome to the **AWS Lambda Powertools for .NET API** reference. This documentation contains the API details for all supported utilities.
44

5-
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.
5+
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.
66

77
> [!NOTE]
88
> Are you looking for documentation on how to use AWS Lambda Powertools for .NET utilities and code samples?

apidocs/toc.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1-
- name: API
1+
- name: API Documentation
22
href: api/
33
homepage: api/index.md
4+
- name: AWS Lambda Powertools for .NET Documentation
5+
href: "https://awslabs.github.io/aws-lambda-powertools-dotnet/"

0 commit comments

Comments
 (0)