Skip to content

Commit 7f7b297

Browse files
committed
Automated scripts reference document generation (CI)
1 parent 8b4046e commit 7f7b297

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

scripts/SCRIPTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This file was generated with the script [generateScriptReference.sh](./generateS
66

77
Script | Directory | Description
88
-------|-----------|------------
9+
| [activateCondaEnvironment.sh](./activateCondaEnvironment.sh) | | Activates the Conda (Python package manager) environment "codegraph" with all packages needed to execute the Jupyter Notebooks. |
910
| [analyze.sh](./analysis/analyze.sh) | analysis | Coordinates the end-to-end analysis process, encompassing tool installation, graph generation, and report generation. |
1011
| [copyReportsIntoResults.sh](./copyReportsIntoResults.sh) | | Copies the results from the temp directory to the results directory grouped by the analysis name. |
1112
| [detectChangedArtifacts.sh](./detectChangedArtifacts.sh) | | Detect changed files in the artifacts directory with a text file containing the last hash code of the contents. |
@@ -23,6 +24,7 @@ Script | Directory | Description
2324
| [executeJupyterNotebook.sh](./executeJupyterNotebook.sh) | | Executes all steps in the given Jupyter Notebook (ipynb), stores it and converts it to Markdown (md) and PDF. |
2425
| [executeQuery.sh](./executeQuery.sh) | | Utilizes Neo4j's HTTP API to execute a Cypher query from an input file and provides the results in CSV format. |
2526
| [executeQueryFunctions.sh](./executeQueryFunctions.sh) | | Provides functions to execute Cypher queries using either "executeQuery.sh" or Neo4j's "cypher-shell". |
27+
| [operatingSystemFunctions.sh](./operatingSystemFunctions.sh) | | Provides operating system dependent functions e.g. to detect Windows. |
2628
| [prepareAnalysis.sh](./prepareAnalysis.sh) | | Prepares and validates the graph database before analysis |
2729
| [Default.sh](./profiles/Default.sh) | profiles | Sets (if any) settings variables for a default analysis. |
2830
| [Neo4jv4.sh](./profiles/Neo4jv4.sh) | profiles | Sets all settings variables for an analysis with Neo4j v4.4.x (long term support (LTS) version as of may 2023). |
@@ -60,4 +62,4 @@ Script | Directory | Description
6062
| [setupNeo4jInitialPassword.sh](./setupNeo4jInitialPassword.sh) | | Sets the initial password for the local Neo4j Graph Database (https://neo4j.com/download-center/#community). |
6163
| [startNeo4j.sh](./startNeo4j.sh) | | Starts the local Neo4j Graph Database. |
6264
| [stopNeo4j.sh](./stopNeo4j.sh) | | Stops the local Neo4j Graph Database. |
63-
| [waitForNeo4jHttp.sh](./waitForNeo4jHttp.sh) | | Waits until the HTTP Transactions API of Neo4j Graph Database is available. |
65+
| [waitForNeo4jHttpFunctions.sh](./waitForNeo4jHttpFunctions.sh) | | Waits until the HTTP Transactions API of Neo4j Graph Database is available. |

0 commit comments

Comments
 (0)