fix: migrating docs.yml to 0.15.0-rc0 should fail if custom-domain is…

… an array (#3467)
fern-api · Apr 25, 2024 · 3a222a5 · 3a222a5
1 parent f3d1b1a
commit 3a222a5
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/...ations/src/migrations/0.15.0-rc0/update-directory-structure/migrateDocsAndMultipleAPIs.ts b/...ations/src/migrations/0.15.0-rc0/update-directory-structure/migrateDocsAndMultipleAPIs.ts
@@ -10,6 +10,7 @@ import {
     loadRawGeneratorsConfiguration
 } from "./generators-configuration";
 import { PathModificationStrategy } from "./generators-configuration/convertLegacyGeneratorsConfiguration";
+import { migrateDocsInstances } from "./migrateDocsInstances";
 
 const APIS_DIRECTORY = "apis";
 
@@ -93,7 +94,7 @@ async function migrateAndWriteDocsYml({
     }
     const convertedDocsConfig = convertLegacyDocsConfig({
         docsConfiguration,
-        docsURLs,
+        docsURLs: migrateDocsInstances(docsURLs),
         apiName
     });
     const absolutePathToDocsConfig = getAbsolutePathToDocsYaml({ absolutePathToWorkspace });

diff --git a/...igrations/src/migrations/0.15.0-rc0/update-directory-structure/migrateDocsAndSingleAPI.ts b/...igrations/src/migrations/0.15.0-rc0/update-directory-structure/migrateDocsAndSingleAPI.ts
@@ -6,6 +6,7 @@ import { getAbsolutePathToDocsFolder, getAbsolutePathToDocsYaml, loadRawDocsConf
 import { convertLegacyDocsConfig } from "./docs-config/convertLegacyDocsConfig";
 import { getAbsolutePathToGeneratorsConfiguration, loadRawGeneratorsConfiguration } from "./generators-configuration";
 import { convertLegacyGeneratorsConfiguration } from "./generators-configuration/convertLegacyGeneratorsConfiguration";
+import { migrateDocsInstances } from "./migrateDocsInstances";
 
 /**
  * fern/  <------ path to fern directory
@@ -48,7 +49,7 @@ async function migrateAndWriteDocsYml({
     }
     const convertedDocsConfig = convertLegacyDocsConfig({
         docsConfiguration,
-        docsURLs,
+        docsURLs: migrateDocsInstances(docsURLs),
         apiName: undefined
     });
     const absolutePathToDocsConfig = getAbsolutePathToDocsYaml({ absolutePathToWorkspace });

diff --git a/...l-migrations/src/migrations/0.15.0-rc0/update-directory-structure/migrateDocsInstances.ts b/...l-migrations/src/migrations/0.15.0-rc0/update-directory-structure/migrateDocsInstances.ts
@@ -0,0 +1,14 @@
+import { docsYml } from "@fern-api/configuration";
+import { DocsURL } from "./docs-config";
+
+export function migrateDocsInstances(docsURLs: docsYml.RawSchemas.DocsInstances[]): DocsURL[] {
+    return docsURLs.map((docsURL) => {
+        if (Array.isArray(docsURL.customDomain)) {
+            throw new Error("Expected custom-domain to be a string, but it was an array.");
+        }
+        return {
+            ...docsURL,
+            customDomain: docsURL.customDomain
+        };
+    });
+}