cr

fern-api · Oct 2, 2024 · 6e1983c · 6e1983c
1 parent d84b634
commit 6e1983c
Show file tree

Hide file tree

Showing 17 changed files with 20 additions and 20 deletions.
diff --git a/packages/seed/fern/definition/config.yml b/packages/seed/fern/definition/config.yml
@@ -28,7 +28,7 @@ types:
       defaultOutputMode: OutputMode
       generatorType: GeneratorType
 
-      artifactMetadata: optional<ArtifactMetadata>
+      buildScripts: optional<BuildScripts>
 
       customFixtureConfig:
         type: optional<FixtureConfigurations>
@@ -108,8 +108,8 @@ types:
         docs: |
           Environment variables to set when running the generator locally.
 
-  ArtifactMetadata:
-    docs: Metadata relating to the artifact produced by this generator
+  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>

diff --git a/packages/seed/src/commands/register/registerGenerator.ts b/packages/seed/src/commands/register/registerGenerator.ts
@@ -26,7 +26,7 @@ export async function registerGenerator({
         generatorType: convertGeneratorType(generatorConfig.generatorType),
         generatorLanguage: generatorConfig.language,
         dockerImage: generatorConfig.image,
-        scripts: generatorConfig.artifactMetadata
+        scripts: generatorConfig.buildScripts
     });
 
     // Register generator versions

diff --git a/...esources/config/types/ArtifactMetadata.ts → ...pi/resources/config/types/BuildScripts.ts b/...esources/config/types/ArtifactMetadata.ts → ...pi/resources/config/types/BuildScripts.ts
@@ -5,9 +5,9 @@
 import * as FernSeedConfig from "../../..";
 
 /**
- * Metadata relating to the artifact produced by this generator
+ * 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 ArtifactMetadata {
+export interface BuildScripts {
     preInstallScript?: FernSeedConfig.Script;
     installScript?: FernSeedConfig.Script;
     compileScript?: FernSeedConfig.Script;

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,7 +16,7 @@ export interface SeedWorkspaceConfiguration {
     defaultCustomConfig?: Record<string, unknown>;
     defaultOutputMode: FernSeedConfig.OutputMode;
     generatorType: FernSeedConfig.GeneratorType;
-    artifactMetadata?: FernSeedConfig.ArtifactMetadata;
+    buildScripts?: FernSeedConfig.BuildScripts;
     /** Configuration that will be used for any custom fixture specified by --custom-fixture */
     customFixtureConfig?: FernSeedConfig.FixtureConfigurations;
     fixtures?: Record<string, FernSeedConfig.FixtureConfigurations[]>;

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,7 +7,7 @@ export * from "./PublishConfiguration";
 export * from "./TestDockerConfiguration";
 export * from "./TestConfiguration";
 export * from "./LocalBuildInfo";
-export * from "./ArtifactMetadata";
+export * from "./BuildScripts";
 export * from "./DockerCommand";
 export * from "./Script";
 export * from "./DockerScriptConfig";

diff --git a/seed/csharp-model/seed.yml b/seed/csharp-model/seed.yml
@@ -3,7 +3,7 @@ displayName: C# Model
 image: fernapi/fern-csharp-model
 changelogLocation: ../../generators/csharp/model/versions.yml
 
-artifactMetadata:
+buildScripts:
   compileScript:
     - dotnet build src -c Release /p:ContinuousIntegrationBuild=true .
 

diff --git a/seed/csharp-sdk/seed.yml b/seed/csharp-sdk/seed.yml
@@ -3,7 +3,7 @@ irVersion: v53
 image: fernapi/fern-csharp-sdk
 changelogLocation: ../../generators/csharp/sdk/versions.yml
 
-artifactMetadata:
+buildScripts:
   preInstallScript:
     - dotnet tool restore
   compileScript:

diff --git a/seed/fastapi/seed.yml b/seed/fastapi/seed.yml
@@ -3,7 +3,7 @@ displayName: FastAPI
 image: fernapi/fern-fastapi-server
 changelogLocation: ../../generators/python/fastapi/versions.yml
 
-artifactMetadata:
+buildScripts:
   installScript:
     - poetry shell
     - poetry install

diff --git a/seed/go-fiber/seed.yml b/seed/go-fiber/seed.yml
@@ -3,7 +3,7 @@ displayName: Fiber
 image: fernapi/fern-go-fiber
 changelogLocation: ../../generators/go/fiber/versions.yml
 
-artifactMetadata:
+buildScripts:
   compileScript:
     - go build -v ./...
   testScript:

diff --git a/seed/go-model/seed.yml b/seed/go-model/seed.yml
@@ -3,7 +3,7 @@ displayName: Go Model
 image: fernapi/fern-go-model
 changelogLocation: ../../generators/go/model/versions.yml
 
-artifactMetadata:
+buildScripts:
   compileScript:
     - go build -v ./...
   testScript:

diff --git a/seed/go-sdk/seed.yml b/seed/go-sdk/seed.yml
@@ -3,7 +3,7 @@ displayName: Go SDK
 image: fernapi/fern-go-sdk
 changelogLocation: ../../generators/go/sdk/versions.yml
 
-artifactMetadata:
+buildScripts:
   compileScript:
     - go build -v ./...
   testScript:

diff --git a/seed/java-model/seed.yml b/seed/java-model/seed.yml
@@ -3,7 +3,7 @@ displayName: Java Model
 changelogLocation: ../../generators/java/model/versions.yml
 image: fernapi/fern-java-model
 
-artifactMetadata:
+buildScripts:
   compileScript:
     - ./gradlew compileJava
 

diff --git a/seed/java-sdk/seed.yml b/seed/java-sdk/seed.yml
@@ -3,7 +3,7 @@ displayName: Java SDK
 changelogLocation: ../../generators/java/sdk/versions.yml
 image: fernapi/fern-java-sdk
 
-artifactMetadata:
+buildScripts:
   compileScript:
     - ./gradlew compileJava
 

diff --git a/seed/pydantic/seed.yml b/seed/pydantic/seed.yml
@@ -3,7 +3,7 @@ displayName: Pydantic Model
 image: fernapi/fern-pydantic-model
 changelogLocation: ../../generators/python/pydantic/versions.yml
 
-artifactMetadata:
+buildScripts:
   installScript:
     - poetry shell
     - poetry install

diff --git a/seed/python-sdk/seed.yml b/seed/python-sdk/seed.yml
@@ -3,7 +3,7 @@ displayName: Python SDK
 image: fernapi/fern-python-sdk
 changelogLocation: ../../generators/python/sdk/versions.yml
 
-artifactMetadata:
+buildScripts:
   installScript:
     - poetry shell
     - poetry install

diff --git a/seed/ruby-sdk/seed.yml b/seed/ruby-sdk/seed.yml
@@ -3,7 +3,7 @@ displayName: Ruby SDK
 image: fernapi/fern-ruby-sdk
 changelogLocation: ../../generators/ruby/sdk/versions.yml
 
-artifactMetadata:
+buildScripts:
   installScript:
     - bundle install
   testScript:

diff --git a/seed/ts-express/seed.yml b/seed/ts-express/seed.yml
@@ -3,7 +3,7 @@ displayName: TypeScript Express
 changelogLocation: ../../generators/typescript/express/versions.yml
 image: fernapi/fern-typescript-express
 
-artifactMetadata:
+buildScripts:
   installScript:
     - yarn install
   compileScript: