Skip to content

Commit a92f2fc

Browse files
authored
Merge pull request #29 from codacy/feature/add-default-usage-screenshot-DOCS-156
feature: Add screenshot of failed workflow for default usage
2 parents 9c890a1 + 3c8f5c0 commit a92f2fc

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ By default, the Codacy GitHub Action:
3030
- Prints the analysis results on the console, which is visible on the GitHub Action's workflow panel.
3131
- Fails the workflow if it finds at least one issue in your code.
3232

33+
![Failed Codacy analysis workflow](images/failed-workflow.png)
34+
3335
To use the GitHub Action with default settings, add the following to a file `.github/workflows/codacy-analysis.yaml` in your repository:
3436

3537
```yaml
@@ -51,15 +53,15 @@ jobs:
5153
5254
## Integration with GitHub code scanning
5355
54-
Integrate the Codacy GitHub Action with [GitHub code scanning](https://docs.github.com/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) to display the analysis results on your repository under the tab **Security**, page **Code scanning alerts**:
55-
56-
![GitHub code scanning integration](images/github-code-scanning.png)
56+
Integrate the Codacy GitHub Action with [GitHub code scanning](https://docs.github.com/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) to display the analysis results on your repository under the tab **Security**, page **Code scanning alerts**.
5757
5858
In this scenario, the GitHub Action:
5959
6060
- Analyzes each commit and pull request to the `master` or `main` branch by running all supported static code analysis tools for the languages found in your repository.
6161
- Outputs the analysis results to a file `results.sarif`, which is then uploaded to GitHub.
6262

63+
![GitHub code scanning integration](images/github-code-scanning.png)
64+
6365
To use the GitHub Action with GitHub code scanning integration, add the following to a file `.github/workflows/codacy-analysis.yaml` in your repository:
6466

6567
```yaml

images/failed-workflow.png

42.1 KB
Loading

0 commit comments

Comments
 (0)