Merge pull request #64 from yunkon-kim/yunkon-kim-patch-240126

Visualize codebase

.github/workflows/update-diagram.yml

@@ -0,0 +1,65 @@
+name: Update diagram
+on:
+  workflow_dispatch: {}
+  # push:
+  #   branches:
+  #     - main
+
+jobs:
+  update_diagram:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Update diagram
+        # id: make_diagram
+        uses: githubocto/[email protected]
+        with:
+          output_file: "docs/diagrams/visualizing-the-codebase.svg"
+          excluded_paths: "ignore,.github"
+          should_push: false          # Not to create a new commit 
+          # artifact_name: "diagrams"   # Save the diagram to the artifact
+
+      # - name: Get artifact
+      #   uses: actions/download-artifact@v2
+      #   with:
+      #     name: "diagrams"
+      #     path: "downloads"
+
+      - name: Add the updated diagram
+        run: |
+          cd docs/diagrams/
+          git add -v visualizing-the-codebase.svg
+          
+      - name: Create Pull Request
+        id: create-pull-request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.CR_PAT }}
+          commit-message: Update diagram to visualize the codebase
+          committer: cb-bot <[email protected]>
+          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+          signoff: false
+          branch: update-diagram
+          base: main
+          delete-branch: true
+          title: '[Workflow] Update diagram to visualize the codebase [skip ci]'
+          body: |
+            Update diagram to visualize the codebase
+            - Auto-generated by [create-pull-request][1]
+            [1]: https://github.com/peter-evans/create-pull-request
+          labels: |
+            documentation
+            automated pr
+          assignees: cloud-barista/cm-beetle-maintainer
+          reviewers: cloud-barista/cm-beetle-maintainer
+          team-reviewers: |
+            owners
+            maintainers
+          draft: false
+
+      - name: Check outputs
+        run: |
+          echo "Pull Request Number - ${{ steps.create-pull-request.outputs.pull-request-number }}"
+          echo "Pull Request URL - ${{ steps.create-pull-request.outputs.pull-request-url }}"

README.md

@@ -148,3 +148,20 @@ curl http://localhost:8056/beetle/health
 # Output if it's running successfully
 # {"message":"CM-Beetle API server is running"}
 ```
+
+
+---
+
+#### Visualization of the codebase
+
+> How can we “fingerprint” a codebase to see its structure at a glance? 
+> Let’s explore ways to automatically visualize a GitHub repo, 
+> and how that could be useful. - [Visualizing a Codebase](https://githubnext.com/projects/repo-visualization/)
+
+[Explore CM-Beetle codebase](https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=cloud-barista%2Fcm-beetle)
+
+![Visualization of the codebase](./docs/diagrams/visualizing-the-codebase.svg)
+
+Note - this is automatically generated by [Repo Visualizer](https://github.com/marketplace/actions/repo-visualizer) 
+
+CM-Beetle is interested in [Potential future directions](https://githubnext.com/projects/repo-visualization/#potential-future-directions)