Update README.md (#28)

* Remove unavailable badge from README.md

* Add title to README.md

* Suggest using newer `codecov/codecov-action` in README.md
This commit is contained in:
abhro
2025-10-18 20:14:25 -04:00
committed by GitHub
parent 51178d2d1c
commit ecc9c01653

View File

@@ -1,6 +1,4 @@
<p align="center">
<a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
</p>
# `julia-actions/julia-processcoverage` Action
## Usage
@@ -9,9 +7,10 @@ See [PkgTemplates.jl](https://github.com/invenia/PkgTemplates.jl/blob/master/tes
```yaml
- uses: julia-actions/julia-processcoverage@v1
- uses: codecov/codecov-action@v2
- uses: codecov/codecov-action@v5
with:
files: lcov.info
token: ${{ secrets.CODECOV_TOKEN }}
```
One can also specify the directory or directories (comma separated) to use via the `directories` input (which defaults to `src,ext`). E.g.
@@ -20,17 +19,19 @@ One can also specify the directory or directories (comma separated) to use via t
- uses: julia-actions/julia-processcoverage@v1
with:
directories: src,ext,examples
- uses: codecov/codecov-action@v2
- uses: codecov/codecov-action@v5
with:
files: lcov.info
token: ${{ secrets.CODECOV_TOKEN }}
```
instructs the action to look for coverage information in `src`, `ext`, and an `examples` folder. Likewise, use
```yaml
- uses: julia-actions/julia-processcoverage@v1
with:
directories: path/to/subdir/package/src
- uses: codecov/codecov-action@v2
- uses: codecov/codecov-action@v5
with:
files: lcov.info
token: ${{ secrets.CODECOV_TOKEN }}
```
to get coverage information from a package in a subdirectory of the repo.