Merge pull request #2 from seangwright/feat/xperience-29

Feature: Xperience v29.3.0
seangwright · Aug 18, 2024 · 06dc0f2 · 06dc0f2
2 parents 7655375 + 686dac0
commit 06dc0f2
Show file tree

Hide file tree

Showing 9 changed files with 608 additions and 581 deletions.
diff --git a/.github/actions/pack-and-publish/action.yml b/.github/actions/pack-and-publish/action.yml
@@ -1,13 +1,13 @@
-name: 'Pack and Publish'
+name: "Pack and Publish"
 
-description: 'Packs and publishes a .NET Library as a build artifact'
+description: "Packs and publishes a .NET Library as a build artifact"
 
 inputs:
   projectPath:
-    description: 'Path to the project file'
+    description: "Path to the project file"
     required: true
   preReleaseVersion:
-    description: 'The pre-release version to use for the NuGet package'
+    description: "The pre-release version to use for the NuGet package"
     required: true
 
 runs:
@@ -17,8 +17,8 @@ runs:
       run: dotnet pack ${{ inputs.projectPath }} -c Release --no-build --include-symbols -o ./artifacts/prerelease --version-suffix prerelease-${{ inputs.preReleaseVersion }}
       shell: pwsh
 
-    - name: 'Save prerelease artifact'
-      uses: actions/upload-artifact@v3
+    - name: "Save prerelease artifact"
+      uses: actions/upload-artifact@v4
       with:
         name: prerelease
         path: ./artifacts/prerelease/*
@@ -27,8 +27,8 @@ runs:
       run: dotnet pack ${{ inputs.projectPath }} -c Release --no-build --include-symbols -o ./artifacts/release
       shell: pwsh
 
-    - name: 'Save release artifact'
-      uses: actions/upload-artifact@v3
+    - name: "Save release artifact"
+      uses: actions/upload-artifact@v4
       with:
         name: release
-        path: ./artifacts/release/*
+        path: ./artifacts/release/*
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,33 +1,33 @@
-name: 'CI: Build and Test'
+name: "CI: Build and Test"
 
 on:
   push:
     branches: [main]
     paths:
-      - '**.cs'
-      - '**.csproj'
-      - '**.props'
-      - '**.targets'
-      - '**.sln'
+      - "**.cs"
+      - "**.csproj"
+      - "**.props"
+      - "**.targets"
+      - "**.sln"
   pull_request:
     branches: [main]
     paths:
-      - '**.cs'
-      - '**.csproj'
-      - '**.props'
-      - '**.targets'
-      - '**.sln'
+      - "**.cs"
+      - "**.csproj"
+      - "**.props"
+      - "**.targets"
+      - "**.sln"
 
 jobs:
   build:
     name: build
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
           global-json-file: global.json
 

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -1,23 +1,23 @@
-name: 'Release: Publish to NuGet'
+name: "Release: Publish to NuGet"
 
 on:
   workflow_dispatch:
     inputs:
       reason:
-        description: 'The reason for running the workflow'
+        description: "The reason for running the workflow"
         required: true
-        default: 'Manual run'
+        default: "Manual run"
 
 jobs:
   createArtifacts:
     name: Generate NuGet Packages
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
           global-json-file: global.json
 
@@ -30,10 +30,10 @@ jobs:
       - name: Test Solution
         run: dotnet test --configuration Release --no-build --no-restore
 
-      - name: 'Pack and Publish'
+      - name: "Pack and Publish"
         uses: ./.github/actions/pack-and-publish
         with:
-          projectPath: './src/XperienceCommunity.PreviewComponentOutlines'
+          projectPath: "./src/XperienceCommunity.PreviewComponentOutlines"
           preReleaseVersion: ${{ github.run_number }}-${{ github.run_attempt }}
 
   publishPreRelease:
@@ -43,7 +43,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Download artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: prerelease
 
@@ -57,7 +57,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Download artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: release
 

diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "ms-dotnettools.csdevkit",
+    "github.vscode-github-actions",
+    "davidanson.vscode-markdownlint",
+    "ms-vscode.powershell",
+    "esbenp.prettier-vscode"
+  ]
+}
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -7,7 +7,7 @@
 		<Copyright>Copyright © $(Company) $([System.DateTime]::Now.Year)</Copyright>
 		<Trademark>$(Company)™</Trademark>
 		<Product>XperienceCommunity.PreviewComponentOutlines</Product>
-		<VersionPrefix>2.0.0</VersionPrefix>
+		<VersionPrefix>3.0.0</VersionPrefix>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<Title>$(Product)</Title>
 		<PackageProjectUrl>https://github.com/seangwright/xperience-community-preview-component-outlines</PackageProjectUrl>

diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -6,14 +6,14 @@
     <DisableImplicitNuGetFallbackFolder>true</DisableImplicitNuGetFallbackFolder>
   </PropertyGroup>
   <ItemGroup>
-    <PackageVersion Include="Kentico.Xperience.WebApp" Version="28.1.0" />
+    <PackageVersion Include="Kentico.Xperience.WebApp" Version="29.3.0" />
 
-    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-    <PackageVersion Include="NUnit" Version="4.0.1" />
-    <PackageVersion Include="NUnit3TestAdapter" Version="4.5.0" />
-    <PackageVersion Include="NUnit.Analyzers" Version="3.10.0" />
-    <PackageVersion Include="coverlet.collector" Version="6.0.0" />
-    <PackageVersion Include="Kentico.Xperience.Core.Tests" Version="28.1.0" />
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
+    <PackageVersion Include="NUnit" Version="4.1.0" />
+    <PackageVersion Include="NUnit3TestAdapter" Version="4.6.0" />
+    <PackageVersion Include="NUnit.Analyzers" Version="4.3.0" />
+    <PackageVersion Include="coverlet.collector" Version="6.0.2" />
+    <PackageVersion Include="Kentico.Xperience.Core.Tests" Version="29.3.0" />
     <PackageVersion Include="NSubstitute" Version="5.1.0" />
     <PackageVersion Include="FluentAssertions" Version="6.12.0" />
   </ItemGroup>

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Xperience Community: Preview Component Outlines
 
-Enables outlines of Page Builder components in Preview mode for a Page.
+Enables outlines of Page Builder components in Preview mode for [a page in a website channel](https://docs.kentico.com/x/8IfWCQ).
 
 This can help marketers and content managers visualize how various Page Builder components are composed on a page without the design limitations of the Page Builder edit mode.
 
@@ -18,15 +18,16 @@ This can help marketers and content managers visualize how various Page Builder
 
 ## Library Version Matrix
 
-| Xperience Version   | Library Version |
-| ------------------- | --------------- |
-| >= 28.1.0           | 2.x             |
-| >= 25.0.0           | 1.x             |
+| Xperience Version | Library Version |
+| ----------------- | --------------- |
+| >= 29.3.0         | 3.x             |
+| >= 28.1.0         | 2.x             |
+| >= 25.0.0         | 1.x             |
 
 ## Dependencies
 
 - [ASP.NET Core 8.0](https://dotnet.microsoft.com/en-us/download)
-- [Xperience by Kentico](https://docs.xperience.io/xp/changelog)
+- [Xperience by Kentico](https://docs.kentico.com/changelog)
 
 ## Setup