Skip to content

Commit

Permalink
docs: add example pr
Browse files Browse the repository at this point in the history
  • Loading branch information
vladopajic committed Nov 21, 2024
1 parent f1152ff commit e55fc36
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/github_action.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ Below is an example that reports files with coverage below 80% without causing t

Using go-test-coverage, you can display a detailed comparison of code coverage changes relative to the base branch. When this feature is enabled, the report highlights files with coverage differences compared to the base branch.

The same logic is used in workflow in [this repo](/.github/workflows/test.yml).
The same logic is used in workflow in [this repo](/.github/workflows/test.yml).
Example of report that includes coverage difference is [this PR](https://github.com/vladopajic/go-test-coverage/pull/129).

```yml
# Download main (aka base) branch breakdown
Expand Down Expand Up @@ -97,6 +98,7 @@ The same logic is used in workflow in [this repo](/.github/workflows/test.yml).
Here is an example of how to post comments with the coverage report to your pull request.
The same logic is used in workflow in [this repo](/.github/workflows/test.yml).
Example of report is in [this PR](https://github.com/vladopajic/go-test-coverage/pull/129).
```yml
- name: check test coverage
Expand Down

0 comments on commit e55fc36

Please # to comment.