Skip to content

Commit 528522c

Browse files
committed
Automated scripts reference document generation (CI)
1 parent 7835e8b commit 528522c

File tree

1 file changed

+0
-5
lines changed

1 file changed

+0
-5
lines changed

scripts/SCRIPTS.md

-5
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,12 @@ Script | Directory | Description
1010
| [analyze.sh](./analysis/analyze.sh) | analysis | Coordinates the end-to-end analysis process, encompassing tool installation, graph generation, and report generation. |
1111
| [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. |
1212
| [copyPackageJsonFiles.sh](./copyPackageJsonFiles.sh) | | Copies all package.json files inside the source directory into the artifacts/npm-package-json directory. |
13-
| [copyReportsIntoResults.sh](./copyReportsIntoResults.sh) | | Copies the results from the temp directory to the results directory grouped by the analysis name. |
1413
| [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. |
1514
| [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. |
1615
| [detectChangedFiles.sh](./detectChangedFiles.sh) | | Detect changed files in the artifacts directory or in a given list of paths |
1716
| [appendEnvironmentVariables.sh](./documentation/appendEnvironmentVariables.sh) | documentation | Extracts the environment variable declarations including default values from a script file and appends it to a markdown file as table columns. |
18-
| [generateCsvReportReference.sh](./documentation/generateCsvReportReference.sh) | documentation | Generates "CSV_REPORTS.md" containing a reference to all CSV cypher query reports in this directory and its subdirectories. |
1917
| [generateCypherReference.sh](./documentation/generateCypherReference.sh) | documentation | Generates "CYPHER.md" containing a reference to all Cypher files in this directory and its subdirectories. |
2018
| [generateEnvironmentVariableReference.sh](./documentation/generateEnvironmentVariableReference.sh) | documentation | Runs "appendEnvironmentVariable.sh" for every script file in the current directory and its sub directories. |
21-
| [generateImageReference.sh](./documentation/generateImageReference.sh) | documentation | Generates "IMAGES.md" containing a reference to all images (PNG) in this directory and its subdirectories. |
22-
| [generateJupyterReportReference.sh](./documentation/generateJupyterReportReference.sh) | documentation | Generates "JUPYTER_REPORTS.md" containing a reference to all Jupyter Notebook Markdown reports in this directory and its subdirectories. |
23-
| [generateReportReferences.sh](./documentation/generateReportReferences.sh) | documentation | Triggers the regeneration of all reference documentations for the reports inside the "results" directory. |
2419
| [generateScriptReference.sh](./documentation/generateScriptReference.sh) | documentation | Generates "SCRIPTS.md" containing a reference to all scripts in this directory and its subdirectories. |
2520
| [download.sh](./download.sh) | | Downloads a file into the directory of the environment variable SHARED_DOWNLOADS_DIRECTORY (or default "../downloads"). |
2621
| [downloadMavenArtifact.sh](./downloadMavenArtifact.sh) | | Downloads an artifact from Maven Central (https://mvnrepository.com/repos/central) |

0 commit comments

Comments
 (0)