👷‍♂️ Add CI Action to AutoGenerate TypeScript Code (#141)

* add Github Action to autogenerate ts classes

* update json_schemas (after #127)

Author: hf-kklein

.github/workflows/typescript_from_json_schemas.yml

@@ -0,0 +1,36 @@
+name: Generate TypeScript Classes from JSONSchemas
+on:
+  push:
+    paths:
+      - "json_schemas/**.json"
+jobs:
+  generate:
+    name: Generate TypeScript Classes from JSONSchemas
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - name: Install Code Generator
+        run: npm install json-schema-to-typescript -g
+      - name: Run Code Generator
+        run: json2ts -i 'json_schemas/**.json' -o ts_models/
+      - name: Upload TypeScript Files
+        uses: actions/upload-artifact@master
+        with:
+          name: TypeScriptClasses
+          path: ts_models
+      - name: Push ts_models content to type script models repo
+        uses: cpina/[email protected]
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.TS_MODELS_PUSH_TOKEN }}
+        with:
+          source-directory: "ts_models"
+          target-directory: "src"
+          destination-github-username: "Hochfrequenz"
+          destination-repository-name: "ahbicht-ts-models"
+          user-email: [email protected]
+          target-branch: main

json_schemas/CategorizedKeyExtractSchema.json

@@ -53,6 +53,14 @@
           },
           "title": "requirement_constraint_keys",
           "type": "array"
+        },
+        "time_condition_keys": {
+          "items": {
+            "title": "time_condition_keys",
+            "type": "string"
+          },
+          "title": "time_condition_keys",
+          "type": "array"
         }
       },
       "type": "object"

json_schemas/README.md

@@ -9,6 +9,13 @@ This is thought to reduce manual efforts and allow for easy integration of AHBic
 The files in this directory are autogenerated from the marshmallow classes that are also used for (de-)serialization.
 There is a tox environment that executes [`generate_json_schemas.py`](generate_json_schemas.py) and overwrites any `.json` files in this directory.
 Simply run:
+
 ```bash
 tox -e json_schemas
 ```
+
+### Github Action and Type Script Models
+
+The JSON Schemas in this directory are used to autogenerate TypeScript Model classes.
+Therefore, [a Github Action](../.github/workflows/typescript_from_json_schemas.yml) is triggered whenever something is written to this directory.
+The generated classes are uploaded as Action artifact and pushed to [ahbicht-ts-models](https://github.com/Hochfrequenz/ahbicht-ts-models).