Skip to content

Commit fffcd53

Browse files
committed
Deprecate graph-visualization nodejs package in favor of GraphViz.
1 parent 9565fa6 commit fffcd53

File tree

5 files changed

+16
-21
lines changed

5 files changed

+16
-21
lines changed

.github/workflows/java-code-analysis.yml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,6 @@ jobs:
6969
distribution: 'adopt'
7070
java-version: ${{ matrix.java }}
7171

72-
- name: Setup Node.js for Graph Visualization
73-
uses: actions/setup-node@v4
74-
with:
75-
node-version-file: 'graph-visualization/.nvmrc'
76-
77-
- name: Install Node packages for Graph Visualization
78-
working-directory: graph-visualization
79-
run: npm ci
80-
8172
- name: Setup Cache for Conda package manager Miniforge
8273
uses: actions/cache@v4
8374
env:

.github/workflows/typescript-code-analysis.yml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,6 @@ jobs:
6969
distribution: 'adopt'
7070
java-version: ${{ matrix.java }}
7171

72-
- name: Setup Node.js for Graph Visualization
73-
uses: actions/setup-node@v4
74-
with:
75-
node-version-file: 'graph-visualization/.nvmrc'
76-
77-
- name: Install Node packages for Graph Visualization
78-
working-directory: graph-visualization
79-
run: npm ci
80-
8172
- name: Setup Cache for Conda package manager Miniforge
8273
uses: actions/cache@v4
8374
env:

graph-visualization/DEPRECATED.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Render Graph Visualizations (Deprecated)
2+
3+
:warning: **This package is deprecated and might get removed in future.** :warning:
4+
5+
Visualizations are now done using [GraphViz](https://graphviz.org). Please use the new script [visualizeQueryResults.sh](./../scripts/visualization/visualizeQueryResults.sh) like it is done in [InternalDependenciesVisualization.sh](./../scripts/reports/InternalDependenciesVisualization.sh) to create Graph Visualizations.

graph-visualization/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
# Render Graph Visualizations
1+
# Render Graph Visualizations (Deprecated)
22

3-
This [node.js](https://nodejs.org/de) project provides the script [renderVisualizations.js](./renderVisualizations.js) to render all graph visualizations as image files.
3+
:warning: **This package is deprecated and might get removed in future.** :warning:
4+
5+
Visualizations are now done using [GraphViz](https://graphviz.org). Please use the new script [visualizeQueryResults.sh](./../scripts/visualization/visualizeQueryResults.sh) like it is done in [InternalDependenciesVisualization.sh](./../scripts/reports/InternalDependenciesVisualization.sh) to create Graph Visualizations.
6+
7+
This [node.js](https://nodejs.org/de) project provides the script [renderVisualizations.js](./renderVisualizations.js) to render graph visualizations as image files. It shows how to use [Puppeteer](https://pptr.dev) to render HTML5 Canvas elements as images,
8+
jimp to manipulate images and neovis to visualize Neo4j Graphs.
49

510
## Prerequisites
611

scripts/reports/GraphVisualization.sh

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
#!/usr/bin/env bash
22

3-
# Creates the "graph-visualization" report (ipynb, md, pdf) based on the Jupyter Notebook "ArtifactDependencies.ipynb".
3+
# DEPRECATED: Creates the "graph-visualization" report using the (now deprecated) nodejs project "graph-visualization".
44
# It contains the hierarchical artifact dependencies graph
55

66
# Requires executeJupyterNotebook.sh
77

88
# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
99
set -o errexit -o pipefail
1010

11+
echo "GraphVisualization: Graph Visualization with the nodejs project 'graph-visualization' is deprecated and will be skipped."
12+
return 0
13+
1114
# Overrideable Constants (defaults also defined in sub scripts)
1215
REPORTS_DIRECTORY=${REPORTS_DIRECTORY:-"reports"}
1316

0 commit comments

Comments
 (0)