feat(seed): introduce scripts to generators so fern bot can build the…

… SDKs (#4788)
fern-api · Oct 4, 2024 · d35196a · d35196a
1 parent e46a4f7
commit d35196a
Show file tree

Hide file tree

Showing 33 changed files with 264 additions and 342 deletions.
diff --git a/.github/workflows/validate-changelog.yml b/.github/workflows/validate-changelog.yml
@@ -31,8 +31,7 @@ jobs:
   generator-validate:
     strategy:
       matrix:
-        generator:
-          [
+        generator: [
             fastapi,
             pydantic,
             python-sdk,
@@ -44,6 +43,8 @@ jobs:
             java-model,
             java-spring,
             ts-express,
+            csharp-sdk,
+            csharp-model
             php-sdk,
             php-model
           ]

diff --git a/packages/cli/cli/package.json b/packages/cli/cli/package.json
@@ -74,7 +74,7 @@
     "@fern-api/fern-definition-formatter": "workspace:*",
     "@fern-api/cli-migrations": "workspace:*",
     "@fern-api/fern-definition-schema": "workspace:*",
-    "@fern-fern/generators-sdk": "0.109.0-21be2e5be",
+    "@fern-fern/generators-sdk": "0.114.0-5745f9e74",
     "@fern-fern/fiddle-sdk": "0.0.584",
     "@types/get-port": "^4.2.0",
     "ansi-escapes": "^5.0.0",
@@ -115,4 +115,4 @@
     "prettier": "^2.7.1",
     "typescript": "4.6.4"
   }
-}
+}
diff --git a/packages/cli/configuration/package.json b/packages/cli/configuration/package.json
@@ -35,7 +35,7 @@
     "@fern-api/fern-definition-schema": "workspace:*",
     "@fern-fern/fdr-cjs-sdk": "0.108.0-dcb0f740c",
     "@fern-fern/fiddle-sdk": "0.0.584",
-    "@fern-fern/generators-sdk": "0.109.0-21be2e5be",
+    "@fern-fern/generators-sdk": "0.114.0-5745f9e74",
     "find-up": "^6.3.0",
     "js-yaml": "^4.1.0",
     "lodash-es": "^4.17.21",
@@ -57,4 +57,4 @@
     "typescript": "4.6.4",
     "vitest": "^2.0.5"
   }
-}
+}
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "@fern-fern/fdr-cjs-sdk": "0.108.0-dcb0f740c",
-    "@fern-fern/generators-sdk": "0.107.0-00fe26566",
+    "@fern-fern/generators-sdk": "0.114.0-5745f9e74",
     "@fern-api/venus-api-sdk": "0.0.38",
     "@fern-fern/fdr-test-sdk": "^0.0.5297",
     "@fern-fern/fiddle-sdk": "0.0.584"
@@ -44,4 +44,4 @@
     "prettier": "^2.7.1",
     "typescript": "4.6.4"
   }
-}
+}
diff --git a/packages/seed/fern/definition/config.yml b/packages/seed/fern/definition/config.yml
@@ -6,9 +6,9 @@ types:
       publishGa: PublishCommand
       publishRc: PublishCommand
       publishDev: PublishCommand
-      changelogLocation: 
+      changelogLocation:
         type: optional<string>
-        docs: | 
+        docs: |
           The location of the changelog file, the schema of which must follow FDR's `GeneratorReleaseRequest` object.
 
   SeedWorkspaceConfiguration:
@@ -18,30 +18,32 @@ types:
       irVersion: string
       test: TestConfiguration
       publish: PublishConfiguration
-      changelogLocation: 
+      changelogLocation:
         type: optional<string>
-        docs: | 
+        docs: |
           The location of the changelog file, the schema of which must follow FDR's `GeneratorReleaseRequest` object.
 
       language: optional<Language>
       defaultCustomConfig: optional<map<string, unknown>>
       defaultOutputMode: OutputMode
       generatorType: GeneratorType
 
-      customFixtureConfig: 
+      buildScripts: optional<BuildScripts>
+
+      customFixtureConfig:
         type: optional<FixtureConfigurations>
         docs: |
           Configuration that will be used for any custom fixture specified by --custom-fixture
       fixtures:
         type: optional<map<string, list<FixtureConfigurations>>>
-      scripts: optional<list<ScriptConfig>>
-      allowedFailures: 
+      scripts: optional<list<DockerScriptConfig>>
+      allowedFailures:
         type: optional<list<string>>
-        docs: | 
-          List any fixtures that are okay to fail. For normal fixtures 
+        docs: |
+          List any fixtures that are okay to fail. For normal fixtures
           just list the fixture name. For configured fixture list {fixture}:{outputFolder}.
       features: optional<features.GeneratorFeatures>
-  
+
   PublishDockerConfiguration:
     properties:
       context: string
@@ -63,18 +65,18 @@ types:
       Commands can be multi-line, we'll run them all!
     properties:
       workingDirectory: optional<string>
-      versionSubstitution: 
+      versionSubstitution:
         type: optional<string>
-        docs: | 
+        docs: |
           The string to substitute for the version in the command. ex. `"$VERSION"`
       command: DockerCommand
 
   PublishConfiguration:
     discriminated: false
-    union: 
+    union:
       - PublishDocker
       - PublishCommand
-  
+
   TestDockerConfiguration:
     properties:
       image: string
@@ -85,38 +87,50 @@ types:
       docker: TestDockerConfiguration
       local: optional<LocalBuildInfo>
 
-  LocalBuildInfo: 
-    properties: 
-      workingDirectory: 
+  LocalBuildInfo:
+    properties:
+      workingDirectory:
         type: string
-        docs: | 
-          The working directory for the generator. 
-      buildCommand: 
+        docs: |
+          The working directory for the generator.
+      buildCommand:
         type: list<string>
-        docs: | 
-          The command to build the generator locally. 
-          `yarn workspace @fern-api/openapi-generator build` for example. 
+        docs: |
+          The command to build the generator locally.
+          `yarn workspace @fern-api/openapi-generator build` for example.
       runCommand:
         type: string
-        docs: | 
-          The command to run the generator locally. 
+        docs: |
+          The command to run the generator locally.
           `node generators/openapi/dist/cli.cjs` for example.
-      env: 
+      env:
         type: optional<map<string, string>>
-        docs: | 
+        docs: |
           Environment variables to set when running the generator locally.
 
-  DockerCommand: 
+  BuildScripts:
+    docs: Scripts pertaining to the artifact produced by this generator and how to build them (e.g. yarn install && yarn build for the TS SDK)
+    properties:
+      preInstallScript: optional<Script>
+      installScript: optional<Script>
+      compileScript: optional<Script>
+      testScript: optional<Script>
+
+  DockerCommand:
     discriminated: false
-    union: 
+    union:
       - string
       - list<string>
 
-  ScriptConfig:
+  Script:
     properties:
-      docker: string
       commands: list<string>
 
+  DockerScriptConfig:
+    extends: Script
+    properties:
+      docker: string
+
   Language:
     enum:
       - python
@@ -144,7 +158,7 @@ types:
       audiences: optional<list<string>>
       outputFolder: string
       outputVersion: optional<string>
-      outputMode: 
+      outputMode:
         type: optional<OutputMode>
         docs: Overrides the default output mode
 
@@ -157,7 +171,7 @@ types:
 
   ReadmeEndpoint:
     discriminated: false
-    union: 
+    union:
       - string
       - ReadmeEndpointObject
 
@@ -166,9 +180,9 @@ types:
       method: string
       path: string
       stream: optional<boolean>
-  
-  OutputMode: 
-    enum: 
+
+  OutputMode:
+    enum:
       - github
       - local_files
       - publish
diff --git a/packages/seed/package.json b/packages/seed/package.json
@@ -48,7 +48,7 @@
     "@fern-api/workspace-loader": "workspace:*",
     "@fern-fern/fiddle-sdk": "0.0.584",
     "@fern-fern/generator-exec-sdk": "^0.0.898",
-    "@fern-fern/generators-sdk": "0.109.0-21be2e5be",
+    "@fern-fern/generators-sdk": "0.114.0-5745f9e74",
     "@types/pretty-ms": "^5.0.1",
     "chalk": "^5.3.0",
     "console-table-printer": "^2.12.0",
@@ -79,4 +79,4 @@
     "typescript": "4.6.4",
     "vitest": "^2.0.5"
   }
-}
+}
diff --git a/packages/seed/src/commands/register/registerGenerator.ts b/packages/seed/src/commands/register/registerGenerator.ts
@@ -25,7 +25,29 @@ export async function registerGenerator({
         displayName: generatorConfig.displayName,
         generatorType: convertGeneratorType(generatorConfig.generatorType),
         generatorLanguage: generatorConfig.language,
-        dockerImage: generatorConfig.image
+        dockerImage: generatorConfig.image,
+        scripts: {
+            preInstallScript: generatorConfig.buildScripts?.preInstallScript
+                ? {
+                      steps: generatorConfig.buildScripts.preInstallScript.commands
+                  }
+                : undefined,
+            installScript: generatorConfig.buildScripts?.installScript
+                ? {
+                      steps: generatorConfig.buildScripts.installScript.commands
+                  }
+                : undefined,
+            compileScript: generatorConfig.buildScripts?.compileScript
+                ? {
+                      steps: generatorConfig.buildScripts.compileScript.commands
+                  }
+                : undefined,
+            testScript: generatorConfig.buildScripts?.testScript
+                ? {
+                      steps: generatorConfig.buildScripts.testScript.commands
+                  }
+                : undefined
+        }
     });
 
     // Register generator versions

diff --git a/packages/seed/src/commands/test/ScriptRunner.ts b/packages/seed/src/commands/test/ScriptRunner.ts
@@ -3,7 +3,7 @@ import { loggingExeca } from "@fern-api/logging-execa";
 import { TaskContext } from "@fern-api/task-context";
 import { writeFile } from "fs/promises";
 import tmp from "tmp-promise";
-import { ScriptConfig } from "../../config/api";
+import { DockerScriptConfig } from "../../config/api";
 import { GeneratorWorkspace } from "../../loadGeneratorWorkspaces";
 import { Semaphore } from "../../Semaphore";
 
@@ -26,7 +26,7 @@ export declare namespace ScriptRunner {
     }
 }
 
-interface RunningScriptConfig extends ScriptConfig {
+interface RunningScriptConfig extends DockerScriptConfig {
     containerId: string;
 }
 
@@ -78,7 +78,7 @@ export class ScriptRunner {
         outputDir: AbsoluteFilePath;
         taskContext: TaskContext;
         containerId: string;
-        script: ScriptConfig;
+        script: DockerScriptConfig;
     }): Promise<ScriptRunner.RunResponse> {
         taskContext.logger.info(`Running script ${script.commands[0] ?? ""} on ${id}`);
 

diff --git a/packages/seed/src/config/api/resources/config/types/BuildScripts.ts b/packages/seed/src/config/api/resources/config/types/BuildScripts.ts
@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as FernSeedConfig from "../../..";
+
+/**
+ * Scripts pertaining to the artifact produced by this generator and how to build them (e.g. yarn install && yarn build for the TS SDK)
+ */
+export interface BuildScripts {
+    preInstallScript?: FernSeedConfig.Script;
+    installScript?: FernSeedConfig.Script;
+    compileScript?: FernSeedConfig.Script;
+    testScript?: FernSeedConfig.Script;
+}
diff --git a/packages/seed/src/config/api/resources/config/types/DockerScriptConfig.ts b/packages/seed/src/config/api/resources/config/types/DockerScriptConfig.ts
@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as FernSeedConfig from "../../..";
+
+export interface DockerScriptConfig extends FernSeedConfig.Script {
+    docker: string;
+}
diff --git a/...pi/resources/config/types/ScriptConfig.ts → ...nfig/api/resources/config/types/Script.ts b/...pi/resources/config/types/ScriptConfig.ts → ...nfig/api/resources/config/types/Script.ts
@@ -2,7 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export interface ScriptConfig {
-    docker: string;
+export interface Script {
     commands: string[];
 }
diff --git a/packages/seed/src/config/api/resources/config/types/SeedWorkspaceConfiguration.ts b/packages/seed/src/config/api/resources/config/types/SeedWorkspaceConfiguration.ts
@@ -16,10 +16,11 @@ export interface SeedWorkspaceConfiguration {
     defaultCustomConfig?: Record<string, unknown>;
     defaultOutputMode: FernSeedConfig.OutputMode;
     generatorType: FernSeedConfig.GeneratorType;
+    buildScripts?: FernSeedConfig.BuildScripts;
     /** Configuration that will be used for any custom fixture specified by --custom-fixture */
     customFixtureConfig?: FernSeedConfig.FixtureConfigurations;
     fixtures?: Record<string, FernSeedConfig.FixtureConfigurations[]>;
-    scripts?: FernSeedConfig.ScriptConfig[];
+    scripts?: FernSeedConfig.DockerScriptConfig[];
     /**
      * List any fixtures that are okay to fail. For normal fixtures
      * just list the fixture name. For configured fixture list {fixture}:{outputFolder}.

diff --git a/packages/seed/src/config/api/resources/config/types/index.ts b/packages/seed/src/config/api/resources/config/types/index.ts
@@ -7,8 +7,10 @@ export * from "./PublishConfiguration";
 export * from "./TestDockerConfiguration";
 export * from "./TestConfiguration";
 export * from "./LocalBuildInfo";
+export * from "./BuildScripts";
 export * from "./DockerCommand";
-export * from "./ScriptConfig";
+export * from "./Script";
+export * from "./DockerScriptConfig";
 export * from "./Language";
 export * from "./GeneratorType";
 export * from "./FixtureConfigurations";