Merge pull request #4 from Kentico/fix/configuration-and-setup

Fix: Configuration and Setup instructions
Kentico · Feb 26, 2024 · 024bf1f · 024bf1f
2 parents cf7feb2 + 6b5cf40
commit 024bf1f
Show file tree

Hide file tree

Showing 11 changed files with 944 additions and 432 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -37,10 +37,16 @@ jobs:
       DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
       DOTNET_NOLOGO: 1
       SIGN_FILE: false
+      PROJECT_NAME: Kentico.Xperience.AzureSearch
 
     steps:
       - uses: actions/checkout@v3
 
+      - name: "Install Node.js from package.json version"
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ./src/${{ env.PROJECT_NAME }}/Admin/Client/package.json
+
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
@@ -53,4 +59,4 @@ jobs:
         run: dotnet build --configuration Release --no-restore
 
       - name: Test Solution
-        run: dotnet test --configuration Release --no-build --no-restore
+        run: dotnet test --configuration Release --no-build --no-restore
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -101,7 +101,10 @@
       "group": "build",
       "problemMatcher": [],
       "label": "npm: build - src/Kentico.Xperience.AzureSearch/Admin/Client",
-      "detail": "webpack --mode=production"
+      "detail": "webpack --mode=production",
+      "dependsOn": [
+        "npm: install - src/Kentico.Xperience.AzureSearch/Admin/Client"
+      ]
     },
     {
       "type": "npm",
@@ -110,15 +113,21 @@
       "group": "build",
       "problemMatcher": [],
       "label": "npm: build:dev - src/Kentico.Xperience.AzureSearch/Admin/Client",
-      "detail": "webpack --mode=development"
+      "detail": "webpack --mode=development",
+      "dependsOn": [
+        "npm: install - src/Kentico.Xperience.AzureSearch/Admin/Client"
+      ]
     },
     {
       "type": "npm",
       "script": "start",
       "path": "src/Kentico.Xperience.AzureSearch/Admin/Client",
       "problemMatcher": [],
       "label": "npm: start - src/Kentico.Xperience.AzureSearch/Admin/Client",
-      "detail": "webpack serve --mode development"
+      "detail": "webpack serve --mode development",
+      "dependsOn": [
+        "npm: install - src/Kentico.Xperience.AzureSearch/Admin/Client"
+      ]
     }
   ]
 }
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -11,16 +11,16 @@
     <PackageVersion Include="Kentico.Xperience.WebApp" Version="28.2.1" />
     <PackageVersion Include="kentico.xperience.azurestorage" Version="28.2.1" />
     <PackageVersion Include="kentico.xperience.imageprocessing" Version="28.2.1" />
-	<PackageVersion Include="Kentico.Xperience.Core.Tests" Version="28.2.1" />
+    <PackageVersion Include="Kentico.Xperience.Core.Tests" Version="28.2.1" />
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
-    <PackageVersion Include="SonarAnalyzer.CSharp" Version="9.6.0.74858" />
-	  
-	<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-	<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="NSubstitute" Version="5.1.0" />
-	<PackageVersion Include="FluentAssertions" Version="6.12.0" />
-	<PackageVersion Include="AutoFixture" Version="4.18.1" />
+    <PackageVersion Include="SonarAnalyzer.CSharp" Version="9.20.0.85982" />
+
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
+    <PackageVersion Include="NUnit3TestAdapter" Version="4.5.0" />
+    <PackageVersion Include="NUnit.Analyzers" Version="4.0.1" />
+    <PackageVersion Include="coverlet.collector" Version="6.0.1" />
+    <PackageVersion Include="NSubstitute" Version="5.1.0" />
+    <PackageVersion Include="FluentAssertions" Version="6.12.0" />
+    <PackageVersion Include="AutoFixture" Version="4.18.1" />
   </ItemGroup>
 </Project>
diff --git a/docs/Contributing-Setup.md b/docs/Contributing-Setup.md
@@ -59,6 +59,18 @@ To run the Sample app Admin customization in development mode, add the following
 }
 ```
 
+Then start Webpack dev server by running the scripts found in `~/src/Kentico.Xperience.AzureSearch/Admin/Client/package.json`
+
+- Use VS Code to run the [pre-defined task](https://code.visualstudio.com/Docs/editor/tasks) `npm: start - src/Kentico.Xperience.AzureSearch/Admin/Client`
+
+- If you are not using VS Code, you can run the scripts manually from the command line (optional)
+
+  ```pwsh
+  cd .\src\Kentico.Xperience.AzureSearch\Admin\Client\
+  npm install
+  npm start
+  ```
+
 ## Development Workflow
 
 1. Create a new branch with one of the following prefixes

diff --git a/examples/DancingGoat/packages.lock.json b/examples/DancingGoat/packages.lock.json
@@ -55,9 +55,9 @@
       },
       "SonarAnalyzer.CSharp": {
         "type": "Direct",
-        "requested": "[9.6.0.74858, )",
-        "resolved": "9.6.0.74858",
-        "contentHash": "tBwiOBYcoSyHVUejjz6iH3VOpSFx7gJSuQ3695BQaoqQBcqy0IeRsKAk5FAR4fbm3QLyEM9bimKk1l038TFN2w=="
+        "requested": "[9.20.0.85982, )",
+        "resolved": "9.20.0.85982",
+        "contentHash": "c0IYtFg4mYusTafTy0Bs5wev45vRKNShkuoWyQyPMbC6imEFHL7tY/7xbbUJd6JNLYx5vP8wyi2LgiBsMHqb2Q=="
       },
       "AngleSharp": {
         "type": "Transitive",