Skip to content

Commit 8677a6f

Browse files
committed
Automated scripts reference document generation (CI)
1 parent edb66b1 commit 8677a6f

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

scripts/SCRIPTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Script | Directory | Description
1212
| [checkCompatibility.sh](./checkCompatibility.sh) | | Check environment dependencies and tool availability. |
1313
| [cleanupAfterReportGeneration.sh](./cleanupAfterReportGeneration.sh) | | Cleans up after report generation. This includes deleting empty files or in case no file is left deleting the report folder. |
1414
| [cloneGitRepository.sh](./cloneGitRepository.sh) | | Provides safe-guarded (security checked parameters) git repository cloning. |
15+
| [configureNeo4j.sh](./configureNeo4j.sh) | | Configures a (local) Neo4j Community Edition Graph Database (https://neo4j.com/download-center/#community). |
1516
| [createAggregatedGitLogCsv.sh](./createAggregatedGitLogCsv.sh) | | Uses git log to create a comma separated values (CSV) file containing aggregated changes, their author name and email address, year and month for all the files that were changed. |
1617
| [createGitLogCsv.sh](./createGitLogCsv.sh) | | Uses git log to create a comma separated values (CSV) file containing all commits, their author, email address, date and all the file names that were changed with it. |
1718
| [detectChangedFiles.sh](./detectChangedFiles.sh) | | Detect changed files in the artifacts directory or in a given list of paths |
@@ -89,10 +90,12 @@ Script | Directory | Description
8990
| [startNeo4j.sh](./startNeo4j.sh) | | Starts the local Neo4j Graph Database. |
9091
| [stopNeo4j.sh](./stopNeo4j.sh) | | Stops the local Neo4j Graph Database. |
9192
| [testCloneGitRepository.sh](./testCloneGitRepository.sh) | | Tests "cloneGitRepository.sh". |
93+
| [testConfigureNeo4j.sh](./testConfigureNeo4j.sh) | | Tests "configureNeo4j.sh". |
9294
| [testDetectChangedFiles.sh](./testDetectChangedFiles.sh) | | Tests "detectChangedFiles.sh". |
9395
| [testDownloadMavenArtifacts.sh](./testDownloadMavenArtifacts.sh) | | Tests "downloadMavenArtifacts.sh". |
9496
| [testFilenameReferences.sh](./testFilenameReferences.sh) | | Tests: scan all *.sh files (current directory including subdirectories) |
9597
| [testInstallJavaScriptDependencies.sh](./testInstallJavaScriptDependencies.sh) | | Tests "installJavaScriptDependencies.sh". |
98+
| [useNeo4jHighMemoryProfile.sh](./useNeo4jHighMemoryProfile.sh) | | Use the high memory profile and apply its configuration template on the local |
9699
| [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. |
97100
| [renderGraphVizSVG.sh](./visualization/renderGraphVizSVG.sh) | visualization | Renders the given GraphViz file as a SVG image. |
98101
| [visualizeQueryResults.sh](./visualization/visualizeQueryResults.sh) | visualization | Visualizes the Cypher query result (CSV format) using GraphViz and outputs it as SVG image. |

0 commit comments

Comments
 (0)