Skip to content

Commit

Permalink
[#1427] Fix non-rendering PlantUML diagram (#2005)
Browse files Browse the repository at this point in the history
The Report Architecture image cannot be rendered automatically from the
puml due to Graphviz not being installed during the CI process.

Let's add the step to install Graphviz in the integration and GitHub
pages workflow.

By rendering the puml directly, this eliminates the need to manually
convert the puml to a png image.
  • Loading branch information
yhtMinceraft1010X committed May 21, 2023
1 parent 50dd4ab commit 3878389
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 2 deletions.
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.

0 comments on commit 3878389

Please sign in to comment.