Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#1427] Fix non-rendering PlantUML diagram #2005

Merged
merged 6 commits into from
May 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ jobs:
restore-keys: |
${{ runner.os }}-node-

- name: Install Graphviz
run: sudo apt-get -y install graphviz

- name: Install MarkBind CLI
run: npm i -g markbind-cli

Expand Down
1 change: 1 addition & 0 deletions .github/workflows/integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ jobs:
if: ${{ success() && github.event_name == 'pull_request' && matrix.os == 'ubuntu-20.04' }}
run: |
git fetch --all && git config --global user.email "-" && git config --global user.name "-" && ./gradlew run -Dargs="--since d1"
sudo apt-get -y install graphviz
npm install -g markbind-cli
(cd docs && markbind build)

Expand Down
3 changes: 1 addition & 2 deletions docs/dg/report.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ The following is a snapshot of the report:

## Report architecture

<!-- Use image instead of puml diagram for this as auto-render may not work -->
![report architecture](../images/report-architecture.png)
<puml src="../diagrams/ReportArchitecture.puml"/>

The main Vue object (`app.vue`) is responsible for loading the report via an async call to `api.ts`, which parses `summary.json`. Its `repos` attribute is tied to the global `window.REPOS`, and is passed into the various other modules when the information is needed.

Expand Down
Binary file removed docs/images/report-architecture.png
Binary file not shown.
Loading