Add script to generate mermaid graph of automations (#26432)

element-hq · Oct 27, 2023 · e5d4d51 · e5d4d51
1 parent bce8207
commit e5d4d51
Show file tree

Hide file tree

Showing 4 changed files with 648 additions and 2 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -83,6 +83,11 @@ jobs:
                   mv element-web/book.toml .
                   mdbook-mermaid install .
 
+            - name: Generate automations docs
+              run: |
+                  npx ts-node element-web/scripts/gen-workflow-mermaid.ts element-desktop element-web matrix-react-sdk matrix-js-sdk > docs/automations.md
+                  echo "-   [Automations](automations.md)" >> docs/SUMMARY.md
+
             - name: Build docs
               run: mdbook build
 

diff --git a/package.json b/package.json
@@ -186,7 +186,8 @@
         "webpack-dev-server": "^4.15.1",
         "worker-loader": "^3.0.0",
         "worklet-loader": "^2.0.0",
-        "yaml": "^2.0.1"
+        "yaml": "^2.3.3",
+        "cronstrue": "^2.41.0"
     },
     "@casualbot/jest-sonar-reporter": {
         "outputDirectory": "coverage",