Skip to content

Commit

Permalink
Mention forks in the README.md limitations
Browse files Browse the repository at this point in the history
  • Loading branch information
fgrosse committed Jun 11, 2024
1 parent 345d050 commit feb8e6a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,9 @@ with the summary of the code coverage changes.
- Currently, code coverage profiles are uploaded as GitHub artifacts which automatically expire after 90 days.
In a repository which receives changes only infrequently, this might lead to issues when trying to compare
the code coverage of a pull request with the code coverage of the main branch (see fgrosse/go-coverage-report#5).
- Support **for forks** is limited since the necessary `GITHUB_TOKEN` permissions don't allow to post comments to the
pull request of the base repository (see fgrosse/go-coverage-report#15). If forks are important for you, this action
might not be the best solution.
- Packages with a name that differs from their directory on disk are not supported yet.
- Requires `actions/upload-artifact` >= **v4** (see this [issue][upload-artifacts-issues]).

Expand Down

0 comments on commit feb8e6a

Please sign in to comment.