Note: THIS FILE IS AUTOMATICALLY GENERATED ON COMMIT. IT SHOULD NOT BE EDITED MANUALLY.
To regenerate this file, run :
npm run genReportDocs
Reports are classes that aggregate the data gathered by a rule and output it to a csv and json file. They run very quickly and therefore have no need to be cached.
There are three main types of reports:
Repo: Repo reports aggregate data on things we care about across repos in the org.
Org: Reports on the organization the repos are found in.
Overall: Reports that output data about every repo based on the repo reports.
| Report | Type | Output Directory | Number of Output Files Generated | Description of Output | Contributes to Overall HealthScore Report | Weight |
|---|---|---|---|---|---|---|
| CodeScanAlertCountReport | simple | CodeScanAlertCountReports | 4 | The number of code scanning alerts at each level: critical, high, medium,and low for every repo. | true | 5 |
| CodeScanAlertReport | simple | CodeScanAlertReports | 4 | Detailed information about code scanning alerts at each level: critical, high, medium,and low, for every repo. | false | 0 |
| DefaultBranchFileTypesReport | simple | DefaultBranchFileTypesReport | 1 | The file type percentages of the files on the default branch of each repo. | false | 0 |
| DependabotAlertReport | simple | DependabotAlertReport | 4 | The number of dependabot scanning alerts at each level: critical, high, medium,and low for every repo. | false | 0 |
| DependabotAlertScanCountReport | simple | DependabotAlertCountReport | 4 | Detailed information on dependabot scanning alerts at each level: critical, high, medium,and low for every repo. | true | 5 |
| DependabotBranchReport | simple | DependabotBranchReport | 1 | The number dependabot branches on every repo. | true | 4 |
| DevPrdBranchesReport | simple | DevPrdBranchesReport | 1 | Repos without the standard "dev" and "prd" branch naming scheme. | false | 0 |
| DockerfileImageReport | simple | DockerfileImageReport | 1 | Instances of docker image usage across repos and branches. | false | 0 |
| DockerfileImageReport | simple | DockerfileImageCondensedReport | 1 | The condensed version of the DockerfileImageReport dependency report | false | 0 |
| GHActionModuleReport | simple | GHActionModuleReport | 1 | Instances of gha module usage across repos and branches. | false | 0 |
| GHActionModuleCondensedReport | simple | GHActionModuleCondensedReport | 1 | The condensed version of the GHActionModule dependency report. | false | 0 |
| LicenseReport | simple | LicenseReport | 1 | What licenses do repos with licenses use | false | 0 |
| LowFileBranchReport | simple | LowFileBranchReport | 1 | The the branches with a low (<=5) file count. | false | 0 |
| LowFileRepoReport | simple | LowFileRepoReport | 1 | The the repos with a low (<=5) file count on every branch. | true | 1 |
| NPMDependencyReport | simple | NPMDependencyReport | 1 | Instances of npm dependency usage across repos and branches. | false | 0 |
| NPMDependencyCondensedReport | simple | NPMDependencyCondensedReport | 1 | The condensed version of the NPMDependency dependency report | false | 0 |
| NodeBranchVersionReport | version | NodeVersionReport | 2 | Lowest and highest node versions on each branch in the org and the default branches of every repo in the org. | false | 0 |
| OpenAPIReport | simple | OpenAPIReport | 1 | What repos have an OpenAPI file on their default branch | false | 0 |
| PIPDependencyReport | simple | PIPDependencyReport | 1 | Instances of pip dependency usage across repos and branches. | false | 0 |
| PIPDependencyCondensedReport | simple | PIPDependencyCondensedReport | 1 | The condensed version of the PIPDependency report. | false | 0 |
| NodeRepoVersionReport | version | NodeVersionReport | 1 | Lowest and highest node versions on every repo in the org, considering every branch in the org. | true | 5 |
| PrimaryLanguageReport | simple | PrimaryLanguageReport | 1 | The primary language for every repo in the org. | false | 0 |
| PublicAndInternalReport | simple | PublicAndInternalReport | 1 | Repos that are marked as public or internal. | true | 2 |
| PythonBranchVersionReport | version | PythonVersionReport | 2 | Lowest and highest python versions on each branch in the org and the default branches of every repo in the org. | false | 0 |
| PythonRepoVersionReport | version | PythonVersionReport | 1 | Lowest and highest python versions on every repo in the org, considering every branch in the org. | true | 5 |
| ReadmeReport | simple | ReadmeReport | 1 | Whether repos have a readme, whether it includes a title, and how many required sections they are missing. | true | 3 |
| RepoHasLanguageReport | simple | RepoHasLanguageReport | 2 | Which repos contain a language, and the percentage of file extensions on each the default branch of each repo. | false | 0 |
| ReposWithoutNewCommitsReport | simple | ReposWithoutNewCommitsReport | 1 | Repos without a new commit in the last two years. | true | 3 |
| SecretScanAlertCountReport | simple | SecretScanAlertCountReport | 1 | The number of secret scanning alerts for each repo. | true | 5 |
| SecretScanAlertReport | simple | SecretScanAlertReport | 1 | Detailed information on every secret scanning alert for every repo in the org. | false | 0 |
| StaleBranchReport | simple | StaleBranchReport | 1 | The number of stale branches on every repo in the org. | true | 2 |
| TeamlessRepoReport | simple | TeamlessRepoReport | 1 | The repos in the org that do not have an admin team in Github, along with the user admins of the repo. | true | 4 |
| TerraformModuleReport | simple | TerraformModuleReport | 1 | Instances of terraform module usage across repos and branches. | false | 0 |
| TerraformModuleCondensedReport | simple | TerraformModuleCondensedReport | 1 | The condensed version of the TerraformModuleReport. | false | 0 |
| TerraformBranchVersionReport | version | TerraformVersionReport | 2 | Lowest and highest terraform versions on each branch in the org and the default branches of every repo in the org. | false | 0 |
| TerraformRepoVersionReport | version | TerraformVersionReport | 1 | Lowest and highest terraform versions on every repo in the org considering every branch in the org. | true | 5 |
| Report | Output Directory | Number of Output Files Generated | Description of Output |
|---|---|---|---|
| OrgReport | OrganizationReports | 1 | Details about the organization. |
| OrgMemberReport | OrganizationReports | 1 | Details about the organization teams. |
| OrgTeamReport | OrganizationReports | 1 | Details about the organization members. |
| Report | Output Directory | Number of Output Files Generated | Description of Output |
|---|---|---|---|
| OverallBranchReport | OverallReports | 1 | General details about every non-dependabot branch in the org |
| OverallRepoReport | OverallReports | 1 | General details about the non archived repo in the org |
| OverallHealthScoreReport | OverallReports | 1 | A healthscore is assigned to each repo based on contributing repo reports. More info can be found in the "Overall Health Scoring" section of the README.md file. |