Skip to content

Commit

Permalink
Update README: Include information on required upload-artifact version (
Browse files Browse the repository at this point in the history
#24)

* Update README.md

Add information noting that you must use upload-artifact@v4 for the subsequent `gh run download` calls to work.

* fix link

* Change wording and format regarding minimum version of actions/upload-artifact

---------

Co-authored-by: Friedrich Große <friedrich.grosse@gmail.com>
  • Loading branch information
peter-crist and fgrosse authored Jun 11, 2024
1 parent 7469ef9 commit 345d050
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ with the summary of the code coverage changes.
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).
- 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]).

## Built With

Expand Down Expand Up @@ -186,3 +187,4 @@ This project is licensed under the BSD-3-Clause License - see the [LICENSE](LICE
[releases]: https://github.com/fgrosse/go-coverage-report/release
[contributors]: https://github.com/fgrosse/go-coverage-report/contributors
[built-with]: go.mod
[upload-artifacts-issues]: https://github.com/cli/cli/issues/5625#issuecomment-1857787634

0 comments on commit 345d050

Please sign in to comment.