Skip to content

Commit 4f846a0

Browse files
committed
Automated scripts reference document generation (CI)
1 parent 7d9251a commit 4f846a0

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

scripts/SCRIPTS.md

+2
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,15 @@ Script | Directory | Description
6666
| [VisualizationReports.sh](./reports/compilations/VisualizationReports.sh) | compilations | Runs all Visualization reports. |
6767
| [resetAndScan.sh](./resetAndScan.sh) | | Deletes all data in the Neo4j graph database and rescans the downloaded artifacts to create a new graph. |
6868
| [resetAndScanChanged.sh](./resetAndScanChanged.sh) | | Executes "resetAndScan.sh" only if "detectChangedFiles.sh" returns detected changes. |
69+
| [runTests.sh](./runTests.sh) | | Runs all test scripts (no Python and Chromium required). |
6970
| [scanTypescript.sh](./scanTypescript.sh) | | Executes the npm package @jqassistant/ts-lc using npx to scan the Typescript projects in the source directory and create an intermediate json data file for the jQAssistant Typescript plugin. |
7071
| [setupJQAssistant.sh](./setupJQAssistant.sh) | | Installs (download and unzip) jQAssistant (https://jqassistant.github.io/jqassistant/current). |
7172
| [setupNeo4j.sh](./setupNeo4j.sh) | | Installs (download, unpack, get plugins, configure) a local Neo4j Graph Database (https://neo4j.com/download-center/#community). |
7273
| [setupNeo4jInitialPassword.sh](./setupNeo4jInitialPassword.sh) | | Sets the initial password for the local Neo4j Graph Database (https://neo4j.com/download-center/#community). |
7374
| [sortOutExternalJavaJarFiles.sh](./sortOutExternalJavaJarFiles.sh) | | Sorts out jar files that don't contain one of the given package names (e.g. external libraries) and moves them into the IGNORED_JARS_DIRECTORY. |
7475
| [startNeo4j.sh](./startNeo4j.sh) | | Starts the local Neo4j Graph Database. |
7576
| [stopNeo4j.sh](./stopNeo4j.sh) | | Stops the local Neo4j Graph Database. |
77+
| [testDetectChangedFiles.sh](./testDetectChangedFiles.sh) | | Tests "detectChangedFiles.sh". |
7678
| [convertQueryResultCsvToGraphVizDotFile.sh](./visualization/convertQueryResultCsvToGraphVizDotFile.sh) | visualization | Converts a Cypher query result in CSV format to a GraphViz DOT (https://graphviz.org/doc/info/lang.html) file for Visualization including layout templates. |
7779
| [visualizeQueryResults.sh](./visualization/visualizeQueryResults.sh) | visualization | Visualizes the Cypher query result (CSV format) using GraphViz and outputs it as SVG image. |
7880
| [waitForNeo4jHttpFunctions.sh](./waitForNeo4jHttpFunctions.sh) | | Waits until the HTTP Transactions API of Neo4j Graph Database is available. |

0 commit comments

Comments
 (0)