Skip to content

Commit 000d1b8

Browse files
committed
Automated scripts reference document generation (CI)
1 parent 58bb3ad commit 000d1b8

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

scripts/SCRIPTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Script | Directory | Description
99
| [activateCondaEnvironment.sh](./activateCondaEnvironment.sh) | | Activates the Conda (Python package manager) environment "codegraph" with all packages needed to run the included Jupyter Notebooks and Python scripts. |
1010
| [activatePythonEnvironment.sh](./activatePythonEnvironment.sh) | | Activates the .venv environment (Python build-in virtual environments) with all packages necessary to run the included Jupyter Notebooks and Python scripts. |
1111
| [analyze.sh](./analysis/analyze.sh) | analysis | Coordinates the end-to-end analysis process, encompassing tool installation, graph generation, and report generation. |
12+
| [checkCompatibility.sh](./checkCompatibility.sh) | | Check environment dependencies and tool availability. |
1213
| [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. |
1314
| [copyPackageJsonFiles.sh](./copyPackageJsonFiles.sh) | | Copies all package.json files inside the source directory into the artifacts/npm-package-json directory. |
1415
| [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. |

0 commit comments

Comments
 (0)