Skip to content

Commit 134d3b7

Browse files
authored
Align docs with constructs and add runtime guards (#46)
* Add validation and sync docs with runtime guards * Fix CI workflow configs * Bump version prefix
1 parent ea697af commit 134d3b7

17 files changed

Lines changed: 227 additions & 229 deletions

.github/workflows/build.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,11 @@ on:
1616
permissions: write-all
1717
jobs:
1818
build:
19-
uses: LayeredCraft/devops-templates/.github/workflows/package-build.yaml@v5.0
19+
uses: LayeredCraft/devops-templates/.github/workflows/package-build.yaml@v6.2
2020
with:
21+
hasTests: true
22+
useMtpRunner: true
23+
testDirectory: "test"
2124
dotnet-version: |
2225
8.0.x
2326
9.0.x

.github/workflows/pr-build.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,15 @@ on:
77
permissions: write-all
88
jobs:
99
build:
10-
uses: LayeredCraft/devops-templates/.github/workflows/pr-build.yaml@v5.0
10+
uses: LayeredCraft/devops-templates/.github/workflows/pr-build.yaml@v6.2
1111
with:
12-
solution: LayeredCraft.Cdk.Constructs.sln
12+
solution: LayeredCraft.Cdk.Constructs.slnx
1313
hasTests: true
14+
useMtpRunner: true
15+
testDirectory: "test"
1416
dotnetVersion: |
1517
8.0.x
1618
9.0.x
19+
10.0.x
1720
runCdk: false
1821
secrets: inherit

Directory.Build.props

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Project>
22
<PropertyGroup>
3-
<VersionPrefix>2.1.1</VersionPrefix>
3+
<VersionPrefix>2.1.2</VersionPrefix>
44
<!-- SPDX license identifier for MIT -->
55
<PackageLicenseExpression>MIT</PackageLicenseExpression>
66

LayeredCraft.Cdk.Constructs.sln

Lines changed: 0 additions & 92 deletions
This file was deleted.

LayeredCraft.Cdk.Constructs.slnx

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<Solution>
2+
<Folder Name="/docs/">
3+
<File Path="docs/index.md" />
4+
<File Path="mkdocs.yml" />
5+
<File Path="requirements.txt" />
6+
</Folder>
7+
<Folder Name="/docs/assets/">
8+
<File Path="docs/assets/icon.png" />
9+
</Folder>
10+
<Folder Name="/docs/assets/css/">
11+
<File Path="docs/assets/css/style.scss" />
12+
</Folder>
13+
<Folder Name="/docs/constructs/">
14+
<File Path="docs/constructs/dynamodb-table.md" />
15+
<File Path="docs/constructs/lambda-function.md" />
16+
<File Path="docs/constructs/static-site.md" />
17+
</Folder>
18+
<Folder Name="/docs/examples/">
19+
<File Path="docs/examples/index.md" />
20+
</Folder>
21+
<Folder Name="/docs/testing/">
22+
<File Path="docs/testing/index.md" />
23+
</Folder>
24+
<Folder Name="/git/">
25+
<File Path=".github/dependabot.yml" />
26+
<File Path=".github/workflows/build.yaml" />
27+
<File Path=".github/workflows/docs.yml" />
28+
<File Path=".github/workflows/pr-build.yaml" />
29+
<File Path=".gitignore" />
30+
</Folder>
31+
<Folder Name="/Solution Items/">
32+
<File Path="CLAUDE.md" />
33+
<File Path="Directory.Build.props" />
34+
<File Path="LICENSE" />
35+
<File Path="README.md" />
36+
</Folder>
37+
<Folder Name="/src/">
38+
<Project Path="src/LayeredCraft.Cdk.Constructs/LayeredCraft.Cdk.Constructs.csproj" />
39+
</Folder>
40+
<Folder Name="/test/">
41+
<Project Path="test/LayeredCraft.Cdk.Constructs.Tests/LayeredCraft.Cdk.Constructs.Tests.csproj" />
42+
</Folder>
43+
</Solution>

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ public class MyStack : Stack
6262
```csharp
6363
var website = new StaticSiteConstruct(this, "Website", new StaticSiteConstructProps
6464
{
65-
SiteBucketName = "my-website-bucket",
6665
DomainName = "example.com",
6766
SiteSubDomain = "www",
6867
AssetPath = "./website-build"
@@ -171,4 +170,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
171170

172171
<!-- ALL-CONTRIBUTORS-LIST:END -->
173172

174-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
173+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)