Skip to content

Commit 84ce202

Browse files
committed
Automated scripts reference document generation (CI)
1 parent 249205d commit 84ce202

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

scripts/SCRIPTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ Script | Directory | Description
3434
| [executeQueryFunctions.sh](./executeQueryFunctions.sh) | | Provides functions to execute Cypher queries using either "executeQuery.sh" or Neo4j's "cypher-shell". |
3535
| [findPathsToScan.sh](./findPathsToScan.sh) | | Finds all files and directories to scan and analyze and provides them as comma-separated list. |
3636
| [importGit.sh](./importGit.sh) | | Coordinates the import of git data from the given --source directory where one ore more git repositories are located and the value of the environment variable IMPORT_GIT_LOG_DATA_IF_SOURCE_IS_PRESENT. |
37+
| [embedMarkdownIncludes.sh](./markdown/embedMarkdownIncludes.sh) | markdown | Processes a template_markdown_file markdown file, replacing placeholders like "<!-- include:intro.md -->" with the contents of the specified markdown files. The files to include needs to be in the "includes" subdirectory. |
38+
| [formatQueryResultAsMarkdownTable.sh](./markdown/formatQueryResultAsMarkdownTable.sh) | markdown | Takes the input stream (Cypher query result in JSON format) and formats it as a Markdown table. |
39+
| [testEmbedMarkdownIncludes.sh](./markdown/testEmbedMarkdownIncludes.sh) | markdown | Tests template processing for markdown by embedding includes. |
40+
| [testFormatQueryResultAsMarkdownTable.sh](./markdown/testFormatQueryResultAsMarkdownTable.sh) | markdown | Tests formatting of Cypher query results as Markdown table. |
3741
| [operatingSystemFunctions.sh](./operatingSystemFunctions.sh) | | Provides operating system dependent functions e.g. to detect Windows. |
3842
| [parseCsvFunctions.sh](./parseCsvFunctions.sh) | | Provides functions to parse strings in CSV format. |
3943
| [prepareAnalysis.sh](./prepareAnalysis.sh) | | Prepares and validates the graph database before analysis |

0 commit comments

Comments
 (0)