feat: add diagram (#453)

Signed-off-by: hxtree <[email protected]>
hxtree · Oct 24, 2023 · e1d9b7d · e1d9b7d
1 parent cae7beb
commit e1d9b7d
Show file tree

Hide file tree

Showing 4 changed files with 152 additions and 12 deletions.
diff --git a/.github/workflows/call-release.yml b/.github/workflows/call-release.yml
@@ -8,19 +8,13 @@ jobs:
     name: release
     timeout-minutes: 15
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
 
       - name: checkout repository
         uses: actions/checkout@v3
 
-      - uses: chrnorm/deployment-action@releases/v1
-        name: Create GitHub deployment
-        id: step-deployment-action
-        with:
-          token: ${{ secrets.GITHUB_TOKEN}}
-          description: 'Upload AWS S3'
-          environment: AWS CodePipeline
-
       - name: setup Node
         uses: actions/setup-node@v3
         with:
@@ -55,7 +49,7 @@ jobs:
         run: node common/scripts/install-run-rush.js build:project
 
       - name: Upload items to Github Release
-        uses: ncipollo/release-action@v1.12.0
+        uses: ncipollo/release-action@v1
         with:
           tag: ${{ github.ref_name }}
           body: |
@@ -64,8 +58,6 @@ jobs:
             We're pleased to share our latest release, which comprises multiple zip files, each housing a distinct, deploy-ready project from @cats-cradle. Within each package, you'll find the project's code and Infrastructure as Code (IaC) authored in AWS CDK v2 for streamlined deployment.
 
             We warmly invite you to delve into the contents of this release, offer your valuable feedback, and actively engage in our project on GitHub. Your contributions and active participation are fundamental to our ongoing efforts to enhance and refine our offerings.
-
-            We extend my gratitude for choosing @cats-cradle and anticipate your invaluable involvement in our expanding community.
           artifacts: 'common/temp/dist/*.zip'
           prerelease: false
           draft: true

diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ Codespaces.
 Alternatively, build, test, and deploy apps locally using the
 [devcontainer](docs/devcontainer.md).
 
-![](docs/assets/images/malace-tsia.jpg)
+![](docs/architecture.png)
 
 ### Pull Request Lifecycle (~5 mins)
 

diff --git a/docs/architecture.drawio b/docs/architecture.drawio
@@ -0,0 +1,148 @@
+<mxfile host="app.diagrams.net" modified="2023-10-24T03:34:30.102Z" agent="Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:109.0) Gecko/20100101 Firefox/118.0" etag="r92H31K0Ilwb5isvT5z2" version="22.0.6" type="device">
+  <diagram name="Page-1" id="dF-n39GfI8d1odxkNiJK">
+    <mxGraphModel dx="2537" dy="860" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
+      <root>
+        <mxCell id="0" />
+        <mxCell id="1" parent="0" />
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-66" value="&lt;div&gt;AWS&lt;/div&gt;&lt;div&gt;&lt;br&gt;&lt;/div&gt;" style="shape=ext;double=1;rounded=0;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=top;align=center;verticalAlign=bottom;" vertex="1" parent="1">
+          <mxGeometry x="-50" y="768.25" width="730" height="269.25" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-24" value="Version Control" style="rounded=0;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=top;align=center;verticalAlign=bottom;fillColor=#e3c800;fontColor=#000000;strokeColor=#B09500;" vertex="1" parent="1">
+          <mxGeometry x="-200" y="20" width="880" height="700" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-61" value="Platform" style="shape=ext;double=1;rounded=1;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=top;align=center;verticalAlign=bottom;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
+          <mxGeometry x="-130" y="552" width="770" height="150" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-11" value="Libraries" style="shape=ext;double=1;rounded=1;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=top;align=center;verticalAlign=bottom;fillColor=#ffe6cc;strokeColor=#d79b00;" vertex="1" parent="1">
+          <mxGeometry x="460" y="80" width="190" height="410" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-44" value="&lt;div&gt;AWS Tools Account&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=top;align=center;verticalAlign=bottom;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="1">
+          <mxGeometry y="800.25" width="365" height="150" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-47" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1" source="EI7FiWirIY5I7oA7hFFx-24" target="EI7FiWirIY5I7oA7hFFx-5">
+          <mxGeometry relative="1" as="geometry">
+            <mxPoint x="-280" y="530" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-10" value="Services" style="shape=ext;double=1;rounded=1;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=top;align=center;verticalAlign=bottom;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
+          <mxGeometry x="-130" y="70" width="540" height="430" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-50" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1" source="EI7FiWirIY5I7oA7hFFx-15">
+          <mxGeometry relative="1" as="geometry">
+            <mxPoint x="-130" y="625.0588235294117" as="targetPoint" />
+            <Array as="points">
+              <mxPoint x="-160" y="220" />
+              <mxPoint x="-160" y="625" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-57" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="EI7FiWirIY5I7oA7hFFx-15" target="EI7FiWirIY5I7oA7hFFx-55">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-58" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="EI7FiWirIY5I7oA7hFFx-15" target="EI7FiWirIY5I7oA7hFFx-56">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-15" value="Service A" style="rounded=1;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=top;align=center;verticalAlign=bottom;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
+          <mxGeometry x="-91.75" y="100" width="463.5" height="240" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-17" value="IaC" style="rounded=1;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=top;align=center;verticalAlign=bottom;" vertex="1" parent="1">
+          <mxGeometry x="72.5" y="128.75" width="270" height="182.5" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-1" value="&lt;div&gt;Lambda&lt;/div&gt;&lt;div&gt;&lt;br&gt;&lt;/div&gt;" style="outlineConnect=0;dashed=0;verticalLabelPosition=bottom;verticalAlign=top;align=center;html=1;shape=mxgraph.aws3.lambda;fillColor=#F58534;gradientColor=none;" vertex="1" parent="1">
+          <mxGeometry x="121.75" y="160" width="76.5" height="93" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-2" value="&lt;div&gt;API Gateway&lt;/div&gt;&lt;div&gt;&amp;nbsp;Proxy Endpoint&lt;/div&gt;" style="outlineConnect=0;dashed=0;verticalLabelPosition=bottom;verticalAlign=top;align=center;html=1;shape=mxgraph.aws3.api_gateway;fillColor=#D9A741;gradientColor=none;" vertex="1" parent="1">
+          <mxGeometry x="230" y="160" width="76.5" height="93" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-3" value="&lt;div&gt;NodeJS&lt;/div&gt;" style="outlineConnect=0;dashed=0;verticalLabelPosition=bottom;verticalAlign=top;align=center;html=1;shape=mxgraph.aws3.android;fillColor=#8CC64F;gradientColor=none;" vertex="1" parent="1">
+          <mxGeometry x="-60" y="164.5" width="73.5" height="84" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-27" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1" source="EI7FiWirIY5I7oA7hFFx-4" target="EI7FiWirIY5I7oA7hFFx-7">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-4" value="&lt;div&gt;S3&lt;/div&gt;" style="outlineConnect=0;dashed=0;verticalLabelPosition=bottom;verticalAlign=top;align=center;html=1;shape=mxgraph.aws3.s3;fillColor=#E05243;gradientColor=none;" vertex="1" parent="1">
+          <mxGeometry x="65" y="822.25" width="76.5" height="93" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-29" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1" source="EI7FiWirIY5I7oA7hFFx-5" target="EI7FiWirIY5I7oA7hFFx-6">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-31" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1">
+          <mxGeometry relative="1" as="geometry">
+            <mxPoint x="-242.52941176470586" y="877.9999999999998" as="sourcePoint" />
+            <mxPoint x="-230" y="980" as="targetPoint" />
+            <Array as="points">
+              <mxPoint x="-243" y="967.75" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-5" value="&lt;div&gt;Github&lt;/div&gt;&lt;div&gt;Actions&lt;br&gt;&lt;/div&gt;" style="dashed=0;outlineConnect=0;html=1;align=center;labelPosition=center;verticalLabelPosition=bottom;verticalAlign=top;shape=mxgraph.weblogos.github" vertex="1" parent="1">
+          <mxGeometry x="-280" y="791.5" width="75" height="75" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-26" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1" source="EI7FiWirIY5I7oA7hFFx-6" target="EI7FiWirIY5I7oA7hFFx-4">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-6" value="Build Artificats" style="shape=image;html=1;verticalAlign=top;verticalLabelPosition=bottom;labelBackgroundColor=#ffffff;imageAspect=0;aspect=fixed;image=https://cdn0.iconfinder.com/data/icons/file-type-19/512/file__zip__compressed_-128.png" vertex="1" parent="1">
+          <mxGeometry x="-150" y="823.75" width="90" height="90" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-46" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="EI7FiWirIY5I7oA7hFFx-7" target="EI7FiWirIY5I7oA7hFFx-34">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-7" value="&lt;div&gt;CodePipeline&lt;/div&gt;&lt;div&gt;&lt;br&gt;&lt;/div&gt;" style="outlineConnect=0;dashed=0;verticalLabelPosition=bottom;verticalAlign=top;align=center;html=1;shape=mxgraph.aws3.codepipeline;fillColor=#759C3E;gradientColor=none;" vertex="1" parent="1">
+          <mxGeometry x="235" y="828.25" width="67.5" height="81" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-21" value="&lt;div&gt;L3 Constructs&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#0050ef;fontColor=#ffffff;strokeColor=#001DBC;" vertex="1" parent="1">
+          <mxGeometry x="-83.25" y="585" width="120" height="60" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-22" value="Rigs" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#0050ef;fontColor=#ffffff;strokeColor=#001DBC;" vertex="1" parent="1">
+          <mxGeometry x="100" y="585" width="120" height="60" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-23" value="Org Formation" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#0050ef;fontColor=#ffffff;strokeColor=#001DBC;" vertex="1" parent="1">
+          <mxGeometry x="290" y="585" width="120" height="60" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-30" value="" style="shape=image;html=1;verticalAlign=top;verticalLabelPosition=bottom;labelBackgroundColor=#ffffff;imageAspect=0;aspect=fixed;image=https://cdn1.iconfinder.com/data/icons/ionicons-fill-vol-2/512/logo-npm-128.png" vertex="1" parent="1">
+          <mxGeometry x="-205" y="924" width="128" height="128" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-37" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1" source="EI7FiWirIY5I7oA7hFFx-34" target="EI7FiWirIY5I7oA7hFFx-35">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="573" y="918" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-34" value="&lt;div&gt;Sandbox Environment&lt;/div&gt;&lt;div&gt;(ephemeral)&lt;br&gt;&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="1">
+          <mxGeometry x="513" y="791.5" width="140" height="60" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-38" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1" source="EI7FiWirIY5I7oA7hFFx-35" target="EI7FiWirIY5I7oA7hFFx-36">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-35" value="Test Environment" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="1">
+          <mxGeometry x="513" y="878" width="140" height="60" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-36" value="&lt;div&gt;Prod Environment&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="1">
+          <mxGeometry x="513" y="958" width="140" height="60" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-52" value="Service B " style="rounded=1;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=middle;align=center;verticalAlign=middle;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
+          <mxGeometry x="-91.75" y="373" width="463.5" height="80" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-55" value="Library A" style="shape=ext;double=1;rounded=1;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=middle;align=center;verticalAlign=middle;fillColor=#60a917;fontColor=#ffffff;strokeColor=#2D7600;" vertex="1" parent="1">
+          <mxGeometry x="490" y="123" width="130" height="67" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-56" value="Library B" style="shape=ext;double=1;rounded=1;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=middle;align=center;verticalAlign=middle;fillColor=#60a917;fontColor=#ffffff;strokeColor=#2D7600;" vertex="1" parent="1">
+          <mxGeometry x="490" y="253" width="130" height="67" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-59" value="..." style="shape=ext;double=1;rounded=1;whiteSpace=wrap;html=1;labelPosition=center;verticalLabelPosition=middle;align=center;verticalAlign=middle;fillColor=#60a917;fontColor=#ffffff;strokeColor=#2D7600;" vertex="1" parent="1">
+          <mxGeometry x="490" y="371" width="130" height="67" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-62" value="..." style="rounded=0;whiteSpace=wrap;html=1;fillColor=#0050ef;fontColor=#ffffff;strokeColor=#001DBC;" vertex="1" parent="1">
+          <mxGeometry x="470" y="585" width="120" height="60" as="geometry" />
+        </mxCell>
+        <mxCell id="EI7FiWirIY5I7oA7hFFx-69" value="" style="shape=link;html=1;rounded=0;entryX=1.003;entryY=0.701;entryDx=0;entryDy=0;entryPerimeter=0;" edge="1" parent="1" target="EI7FiWirIY5I7oA7hFFx-24">
+          <mxGeometry width="100" relative="1" as="geometry">
+            <mxPoint x="-200" y="510" as="sourcePoint" />
+            <mxPoint x="-100" y="510" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+      </root>
+    </mxGraphModel>
+  </diagram>
+</mxfile>
diff --git a/docs/architecture.png b/docs/architecture.png