This repository contains all non-compliant examples from dbLinter.
The CI workflow uses the dbLinter CLI to check all SQL files in this repository and the database objects in the Oracle AI Database for compliance with the dbLinter rules.
The purpose of this repository is to demostrate the use of the dbLinter CLI in a CI/CD environment.
The results are produced using a dbLinter configuration with all rules enabled and default parameters.
The database installation step produced this install.log file.
Raw formats produced by the CLI:
| Name | Description |
|---|---|
| check.log | Trace-level log containing profiles for parsing and checking, which are useful for analysing performance. |
| check.vscode.md | dbLinter Check Report as Markdown for VS Code. |
| check.sonarqube.json | SonarQube Generic formatted issue report to import issues in any SonarQube edition without any plugin. |
| check.sarif.sarif | Static Analysis Results Interchange Format (SARIF) to visualise issues in various tools. See also Viewers. |
| check.checkstyle.xml | Checkstyle XML report. |
| check.github.txt | Workflow commands for GitHub Actions. These commands (annotations) are interpreted when printed to stdout. |
| check.gitlab.json | GitLab quality report. |
The following check results are produced using a previously created input file:
| Result | Producer | Notes |
|---|---|---|
| Summary Check Report | Custom Script | The content of check.vscode.md in the summary page of a run. See also the standalone HTML file. |
| Annotations | Custom Script | The result when printing the content of check.github.txt to stdout. |
| Code Scanning Alerts | github/codeql-action/upload-sarif | This action produces code scanning alerts. The alerts are part of the Security tab, which cannot be made visible to the public. See also About code scanning alerts |
Here's a screenshot of a code scanning alert shown in the non-public tab of this GitHub repository:
Raw formats produced by the CLI:
| Name | Description |
|---|---|
| test.log | Trace-level log. |
| test.vscode.md | dbLinter Test Report as Markdown for VS Code. This report contains also the executed SQL statements. |
| test.junit.xml | JUnit XML reporting file. |
The following test results are produced using a previously created input file:
| Result | Producer | Notes |
|---|---|---|
| Summary Test Report | Custom Script | The content of test.vscode.md in the summary page of a run. See also the standalone HTML file. |
| Test Results (EnricoMi) | EnricoMi/publish-unit-test-result-action | This action produces a own check (job) result. All details of a failure are accessible via a Raw output button. |
| Test Results (dorny) | dorny/test-reporter | This action adds a section in the Summary report of the workflow. |
Here's a screenshot of the report produced by the EnricoMi/publish-unit-test-result-action action:
Here's a screenshot of the report produced by the dorny/test-reporter action:
