feat(release-notes): add support for status and comments

EdricChan03 · Jan 6, 2020 · 02ad1cb · 02ad1cb
1 parent 1c0b345
commit 02ad1cb
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 11 deletions.
diff --git a/projects/rss-reader/src/app/pages/release-notes/release-notes.ts b/projects/rss-reader/src/app/pages/release-notes/release-notes.ts
@@ -7,8 +7,10 @@ export interface Release {
   releaseAuthor?: string;
   /** The Git commit SHA of the version. */
   releaseCommitSha?: string;
-  /** The release type. (Currently not supported) */
-  releaseType?: ReleaseType;
+  /** The release's status. */
+  releaseStatus?: ReleaseStatus[] | string;
+  /** Comments about the release, if any. */
+  releaseComments?: string[] | string;
 }
 
 /**
@@ -31,7 +33,7 @@ export type ReleaseNotes = {
   details?: string[] | string;
 } | string[] | string;
 
-export type ReleaseType = 'stable' | 'beta' | 'nightly';
+export type ReleaseStatus = 'draft' | 'wip' | 'deprecated' | 'released' | 'unreleased' | 'other';
 
 export interface Releases {
   [key: string]: Release;

diff --git a/projects/rss-reader/src/assets/release-notes/release-notes-schema.json b/projects/rss-reader/src/assets/release-notes/release-notes-schema.json
@@ -113,14 +113,37 @@
           "minLength": 7,
           "maxLength": 40
         },
-        "releaseType": {
-          "$comment": "This isn't really supported at the moment",
-          "description": "The release's type.",
-          "type": "string",
-          "enum": [
-            "stable",
-            "beta",
-            "nightly"
+        "releaseStatus": {
+          "description": "The status of the release.",
+          "oneOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/releaseStatusTypes"
+              }
+            },
+            {
+              "$ref": "#/definitions/releaseStatusTypes",
+              "default": "draft"
+            }
+          ]
+        },
+        "releaseComments": {
+          "description": "Internal comments about the release. (Can be a URL)",
+          "oneOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "string",
+              "format": "uri"
+            },
+            {
+              "type": "string"
+            }
           ]
         }
       },
@@ -179,6 +202,17 @@
           "type": "string"
         }
       ]
+    },
+    "releaseStatusTypes": {
+      "type": "string",
+      "enum": [
+        "draft",
+        "wip",
+        "deprecated",
+        "released",
+        "unreleased",
+        "other"
+      ]
     }
   }
 }