`jarvisBaseToolkit` Package Documentation
The jarvisBaseToolkit package contains business logic for generating documentation artifacts and performing code analysis within the Release Management build pipeline.
Dependencies
| Dependent Package | Purpose of this Package |
|---|---|
| baseCanonicalTester | Package to distribute the data integration testing framework. |
| baseCustomizationAnalyzer | Package with static code analysis tools to capture customizations made to a package. |
| baseCodeAnalyzer | Package with functionalities to analyze source code and perform automated Pull Request reviews. |
Key C3 AI Types in this package
| C3 AI Type | Description |
|---|---|
| JarvisBaseToolkit | The Type that contains helper functions for the package. |
| JarvisBaseToolkit.CodeAnalysisInit | The Type that contains functions to initialize code analysis in the Release Management build |
| JarvisBaseToolkit.CodeAnalysis | The Type that contains functions to perform code analysis in the Release Management build |
| JarvisBaseToolkit.DocGen | The Type that contains functions to generate documentation artifacts in the Release Management build |
| JarvisBaseToolkit.CodeAnalysisSummary | The Type that contains functions to summarize code analysis results in the Release Management build |
Key files in this package
The package is structured in the following manner:
Text
jarvisBaseToolkit/
├── src/
│ ├── codeAnalysis/
│ ├── codeAnalysisInit/
│ ├── codeAnalysisSummary/
| ├── docgen/
└── test/| Folder name | Content |
|---|---|
| src/codeAnalysis | Type and implementation to perform code analysis in the Release Management build |
| src/codeAnalysisInit | Type and implementation to initialize code analysis in the Release Management build |
| src/codeAnalysisSummary | Type and implementation to summarize code analysis results in the Release Management build |
| src/docgen | Type and implementation to generate documentation artifacts in the Release Management build |
| test/ | Tests for functions of Types |