Fix API doc generation

Author: damieng

MongoDB.EFCoreProvider.sln

@@ -24,7 +24,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		CODEOWNERS = CODEOWNERS
 		createpr.png = createpr.png
 		packageIcon.png = packageIcon.png
-		global.json = global.json
 		nuget.config = nuget.config
 		sbom.json = sbom.json
 		syncfork.png = syncfork.png
@@ -102,7 +101,7 @@ Global
 		{1BFBE183-6125-402E-826B-1F7A7F86AF00}.Debug EF10|Any CPU.Build.0 = Debug EF10|Any CPU
 		{1BFBE183-6125-402E-826B-1F7A7F86AF00}.Release EF10|Any CPU.ActiveCfg = Release EF10|Any CPU
 		{1BFBE183-6125-402E-826B-1F7A7F86AF00}.Release EF10|Any CPU.Build.0 = Release EF10|Any CPU
-    EndGlobalSection
+	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection

apidocs/docfx.json

@@ -3,15 +3,21 @@
         {
             "src": [
                 {
-                    "files": ["MongoDB.EntityFrameworkCore.dll"],
-                    "src": "../src/MongoDB.EntityFrameworkCore/bin/Debug EF10/net10.0"
+                    "files": [
+                        "**/*.csproj"
+                    ],
+                    "exclude": [
+                        "**/bin/**",
+                        "**/obj/**"
+                    ],
+                    "src": "../src"
                 }
             ],
             "dest": "api",
             "includePrivateMembers": false,
             "disableGitFeatures": false,
             "disableDefaultFilter": false,
-            "noRestore": false,
+            "noRestore": true,
             "namespaceLayout": "flattened",
             "memberLayout": "separatePages",
             "EnumSortOrder": "declaringOrder",
@@ -21,20 +27,32 @@
     "build": {
         "content": [
             {
-                "files": ["api/**.yml", "api/index.md", "api/MongoDB.md"]
+                "files": [
+                    "api/**.yml",
+                    "api/index.md",
+                    "api/MongoDB.md"
+                ]
             },
             {
-                "files": ["*.md"]
+                "files": [
+                    "*.md"
+                ]
             }
         ],
         "resource": [
             {
-                "files": ["images/**"]
+                "files": [
+                    "images/**"
+                ]
             }
         ],
         "globalMetadataFiles": [],
         "fileMetadataFiles": [],
-        "template": ["default", "modern", "mongo-apidocs"],
+        "template": [
+            "default",
+            "modern",
+            "mongo-apidocs"
+        ],
         "postProcessors": [],
         "keepFileLink": false,
         "disableGitFeatures": false,

evergreen/build-apidocs.sh

@@ -2,7 +2,6 @@
 set -o errexit  # Exit the script with error if any of the commands fail
 
 if [ -z "$PACKAGE_VERSION" ]; then
-  PACKAGE_VERSION=$(sh ./evergreen/generate-version.sh)
   echo Calculated PACKAGE_VERSION value: "$PACKAGE_VERSION"
 fi
 
@@ -12,6 +11,24 @@ dotnet new tool-manifest --force
 echo "Installing docfx tool"
 dotnet tool install docfx --version "2.78.4" --local --verbosity q
 
-echo "Building the api-docs"
-dotnet tool run docfx metadata ./apidocs/docfx.json --property ProduceReferenceAssembly=true
+BUILD_CONFIGURATION=""
+if [[ "${PACKAGE_VERSION}" == "8."* ]]; then
+    BUILD_CONFIGURATION="Release EF8"
+fi
+if [[ "${PACKAGE_VERSION}" == "9."* ]]; then
+    BUILD_CONFIGURATION="Release EF9"
+fi
+if [[ "${PACKAGE_VERSION}" == "10."* ]]; then
+    BUILD_CONFIGURATION="Release EF10"
+fi
+
+# Check if BUILD_CONFIGURATION is set
+if [ -z "$BUILD_CONFIGURATION" ]; then
+  echo "Error: Unknown PACKAGE_VERSION $PACKAGE_VERSION found. Update get-build-release-config.sh to handle this version."
+  exit 1
+fi
+
+echo "Building the api-docs for '${PACKAGE_VERSION} using '${BUILD_CONFIGURATION}'"
+dotnet restore src/MongoDB.EntityFrameworkCore/MongoDB.EntityFrameworkCore.csproj -p:Configuration="${BUILD_CONFIGURATION}"
+dotnet tool run docfx metadata ./apidocs/docfx.json --property "Configuration=${BUILD_CONFIGURATION};ProduceReferenceAssembly=true"
 dotnet tool run docfx build ./apidocs/docfx.json -o:./artifacts/apidocs/"$PACKAGE_VERSION"

evergreen/pack-packages.sh

@@ -6,10 +6,22 @@ if [ -z "$PACKAGE_VERSION" ]; then
   echo Calculated PACKAGE_VERSION value: "$PACKAGE_VERSION"
 fi
 
-BUILD_CONFIGURATION="Release"
+BUILD_CONFIGURATION=""
+if [[ "${PACKAGE_VERSION}" == "8."* ]]; then
+    BUILD_CONFIGURATION="Release EF8"
+fi
 if [[ "${PACKAGE_VERSION}" == "9."* ]]; then
     BUILD_CONFIGURATION="Release EF9"
 fi
+if [[ "${PACKAGE_VERSION}" == "10."* ]]; then
+    BUILD_CONFIGURATION="Release EF10"
+fi
+
+# Check if BUILD_CONFIGURATION is set
+if [ -z "$BUILD_CONFIGURATION" ]; then
+  echo "Error: Unknown PACKAGE_VERSION $PACKAGE_VERSION found. Update get-build-release-config.sh to handle this version."
+  exit 1
+fi
 
 echo Creating nuget package $PACKAGE_VERSION using $BUILD_CONFIGURATION build configuration...
 

evergreen/run-smoke-tests.sh

@@ -6,10 +6,22 @@ MONGODB_URI=${MONGODB_URI:=mongodb://localhost:27017/}
 EFCORE_PROVIDER_PROJECT="./src/MongoDB.EntityFrameworkCore/MongoDB.EntityFrameworkCore.csproj"
 TESTS_PROJECT="./tests/MongoDB.EntityFrameworkCore.FunctionalTests/MongoDB.EntityFrameworkCore.FunctionalTests.csproj"
 
-BUILD_CONFIGURATION="Debug"
+BUILD_CONFIGURATION=""
+if [[ "${PACKAGE_VERSION}" == "8."* ]]; then
+    BUILD_CONFIGURATION="Debug EF8"
+fi
 if [[ "${PACKAGE_VERSION}" == "9."* ]]; then
     BUILD_CONFIGURATION="Debug EF9"
 fi
+if [[ "${PACKAGE_VERSION}" == "10."* ]]; then
+    BUILD_CONFIGURATION="Debug EF10"
+fi
+
+# Check if BUILD_CONFIGURATION is set
+if [ -z "$BUILD_CONFIGURATION" ]; then
+  echo "Error: Unknown PACKAGE_VERSION $PACKAGE_VERSION found. Update get-build-release-config.sh to handle this version."
+  exit 1
+fi
 
 echo Retargeting API tests to use generated package instead of project dependency...
 dotnet nuget add source "./artifacts/nuget" -n local --configfile "./nuget.config"

evergreen/run-tests.sh

@@ -2,9 +2,8 @@
 set -o errexit  # Exit the script with error if any of the commands fail
 
 MONGODB_URI=${MONGODB_URI:=mongodb://localhost:27017/}
-BUILD_CONFIGURATION=${BUILD_CONFIGURATION:=Debug}
-
 EFCORE_PROVIDER_PROJECT_PATH="./src/MongoDB.EntityFrameworkCore/MongoDB.EntityFrameworkCore.csproj"
+
 if [ -n "$DRIVER_VERSION" ]
 then
   ## Update Driver's package reference if specified

global.json

@@ -6,6 +6,7 @@
     <PackageId>MongoDB.EntityFrameworkCore</PackageId>
     <Configurations>Debug EF8;Release EF8;Debug EF9;Release EF9;Debug EF10;Release EF10</Configurations>
     <Platforms>AnyCPU</Platforms>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <Import Project="..\..\Versions.props" />
@@ -23,6 +24,7 @@
 
   <PropertyGroup Condition=" '$(Configuration)' == 'Release EF8' ">
     <DefineConstants>TRACE;RELEASE;EF8</DefineConstants>
+    <DocumentationFile>bin\Release EF8\MongoDB.EntityFrameworkCore.xml</DocumentationFile>
     <Optimize>true</Optimize>
   </PropertyGroup>
 
@@ -34,6 +36,7 @@
 
   <PropertyGroup Condition=" '$(Configuration)' == 'Release EF9' ">
     <DefineConstants>TRACE;RELEASE;EF9</DefineConstants>
+    <DocumentationFile>bin\Release EF9\MongoDB.EntityFrameworkCore.xml</DocumentationFile>
     <Optimize>true</Optimize>
   </PropertyGroup>
 
@@ -47,6 +50,7 @@
   <PropertyGroup Condition=" '$(Configuration)' == 'Release EF10' ">
     <TargetFramework>net10.0</TargetFramework>
     <DefineConstants>TRACE;RELEASE;EF10</DefineConstants>
+    <DocumentationFile>bin\Release EF10\MongoDB.EntityFrameworkCore.xml</DocumentationFile>
     <Optimize>true</Optimize>
   </PropertyGroup>