chore(fdr): add tags and PR links to releases data model (#1489)

fern/apis/fdr/definition/generators/cli.yml

@@ -6,19 +6,24 @@ imports:
   commons: ./commons.yml
 
 types:
-  CliReleaseRequest:
-    extends: commons.ReleaseRequest
+  BaseCliRelease:
     properties:
       irVersion:
         type: integer
         docs: The major version of the IR that this CLI exposes.
+      tags:
+        type: optional<list<string>>
+        docs: Tags to categorize the CLI release.
+
+  CliReleaseRequest:
+    extends:
+      - commons.ReleaseRequest
+      - BaseCliRelease
 
   CliRelease:
-    extends: commons.Release
-    properties:
-      irVersion:
-        type: integer
-        docs: The major version of the IR that this CLI exposes.
+    extends:
+      - commons.Release
+      - BaseCliRelease
 
   ListCliReleasesResponse:
     properties:

fern/apis/fdr/definition/generators/commons.yml

@@ -43,8 +43,14 @@ types:
     properties:
       type: ChangelogEntryType
       summary: string
-      upgradeNotes: optional<string>
+      links:
+        type: optional<list<string>>
+        docs: |
+          Any URLs that are relevant to the change, such as a PR or issue. This is optional for backcompat.
 
+          You do not always need to specify the URL as the CLI can fill it in with the current PR, but given you can choose to not
+          release within the same PR as the change is introduced, this should be specified for divorcing the two.
+      upgradeNotes: optional<string>
       # Keep a Changelog
       added: optional<list<string>>
       changed: optional<list<string>>

fern/apis/fdr/definition/generators/versions.yml

@@ -7,8 +7,7 @@ imports:
   root: ./__package__.yml
 
 types:
-  GeneratorReleaseRequest:
-    extends: commons.ReleaseRequest
+  BaseGeneratorRelease:
     properties:
       generatorId: root.GeneratorId
       irVersion:
@@ -20,20 +19,19 @@ types:
       customConfigSchema:
         type: optional<string>
         docs: The JSON schema (stringified) for the custom config that this generator version supports.
+      tags:
+        type: optional<list<string>>
+        docs: Tags to categorize the Generator release.
+
+  GeneratorReleaseRequest:
+    extends:
+      - commons.ReleaseRequest
+      - BaseGeneratorRelease
 
   GeneratorRelease:
-    extends: commons.Release
-    properties:
-      generatorId: root.GeneratorId
-      irVersion:
-        type: integer
-        docs: The major version of the IR that this generator version consumes.
-      migration:
-        type: optional<string>
-        docs: The TypeScript file for the migration to run when upgrading to this version.
-      customConfigSchema:
-        type: optional<string>
-        docs: The JSON schema (stringified) for the custom config that this generator version supports.
+    extends:
+      - commons.Release
+      - BaseGeneratorRelease
 
   ListGeneratorReleasesResponse:
     properties:

servers/fdr/prisma/migrations/20240916153103_add_tags_and_pr_urls/migration.sql

@@ -0,0 +1,5 @@
+-- AlterTable
+ALTER TABLE "CliRelease" ADD COLUMN     "tags" TEXT[] DEFAULT ARRAY[]::TEXT[];
+
+-- AlterTable
+ALTER TABLE "GeneratorRelease" ADD COLUMN     "tags" TEXT[] DEFAULT ARRAY[]::TEXT[];

servers/fdr/prisma/schema.prisma

@@ -203,6 +203,7 @@ model GeneratorRelease {
   customConfigSchema String?
 
   releaseType ReleaseType
+  tags String[]  @default([])
 
   createdAt DateTime @default(now())
   updatedAt DateTime @updatedAt
@@ -222,6 +223,7 @@ model CliRelease {
   changelogEntry Bytes?
 
   releaseType ReleaseType
+  tags String[]  @default([])
 
   createdAt DateTime @default(now())
   updatedAt DateTime @updatedAt

servers/fdr/src/__test__/local/db/cliVersionsDao.test.ts

@@ -21,6 +21,31 @@ it("cli verion not semver", async () => {
     }).rejects.toThrow(new InvalidVersionError({ providedVersion: "abc.1.2" }));
 });
 
+it("cli release with tags and URLs", async () => {
+    const release: CliReleaseRequest = {
+        version: "0.1.2-rc13",
+        irVersion: 0,
+        tags: ["OpenAPI", "Fern Definition"],
+        changelogEntry: [
+            {
+                type: "feat",
+                summary: "added a new feature",
+                added: ["added a new feature"],
+                links: ["https://123.com"],
+            },
+        ],
+    };
+
+    await fdrApplication.dao.cliVersions().upsertCliRelease({
+        cliRelease: release,
+    });
+
+    const dbRelease = await fdrApplication.dao.cliVersions().getCliRelease({ cliVersion: "0.1.2-rc13" });
+    expect(dbRelease).not.toBeUndefined();
+    expect(dbRelease?.tags).toEqual(release.tags);
+    expect(dbRelease?.changelogEntry?.[0]?.links).toEqual(release.changelogEntry?.[0]?.links);
+});
+
 it("cli version get latest respects semver, not time", async () => {
     // create some versions and sleep between them to ensure the timestamps are different
     await fdrApplication.dao.cliVersions().upsertCliRelease({