|
1 | | -# Codecov Action |
| 1 | +<!-- header:start --> |
2 | 2 |
|
3 | | -Action to upload coverage to Codecov with support for container mode. |
| 3 | +#  GitHub Action: Codecov |
| 4 | + |
| 5 | +<div align="center"> |
| 6 | + <img src="https://opengraph.githubassets.com/36aa7cc4e1d084a81183a986cfab32857be10fa31cf7e5e4b9820a5989b4dae9/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Codecov" /> |
| 7 | +</div> |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +<!-- header:end --> |
| 12 | +<!-- badges:start --> |
| 13 | + |
| 14 | +[](https://github.com/marketplace/actions/codecov) |
| 15 | +[](https://github.com/hoverkraft-tech/ci-github-nodejs/releases) |
| 16 | +[](http://choosealicense.com/licenses/mit/) |
| 17 | +[](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social) |
| 18 | +[](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) |
| 19 | + |
| 20 | +<!-- badges:end --> |
| 21 | +<!-- overview:start --> |
4 | 22 |
|
5 | 23 | ## Overview |
6 | 24 |
|
7 | | -This action handles uploading code coverage to Codecov. When running in container mode, it automatically installs required dependencies (Git, cURL, gnupg) via pkgxdev, fixes configuration issues with unexpanded environment variables, uploads coverage, and then cleans up the installed dependencies. |
| 25 | +Action to upload coverage to Codecov. |
| 26 | + |
| 27 | +- **Automatic dependency management**: Automatically detects and installs missing dependencies (Git, cURL, gnupg) using pkgxdev |
| 28 | +- **Configuration fixes**: Automatically fixes pkgxdev configuration issues with unexpanded environment variables in gpgconf.ctl and .curlrc files |
| 29 | +- **Cleanup**: Uninstalls dependencies after Codecov upload is complete |
| 30 | +- **OIDC support**: Uses OIDC authentication with Codecov for secure uploads |
| 31 | + |
| 32 | +<!-- overview:end --> |
| 33 | +<!-- usage:start --> |
8 | 34 |
|
9 | 35 | ## Usage |
10 | 36 |
|
11 | 37 | ```yaml |
12 | | -- uses: hoverkraft-tech/ci-github-nodejs/actions/codecov@main |
| 38 | +- uses: hoverkraft-tech/ci-github-nodejs/actions/codecov@9f334582b395b78e4d7c88fa08a8957a8fe5513c # copilot/fix-variable-expansion-issue |
13 | 39 | with: |
14 | 40 | # Working directory where coverage files are located. |
15 | 41 | # Can be absolute or relative to the repository root. |
16 | 42 | # |
17 | 43 | # Default: `.` |
18 | 44 | working-directory: . |
19 | | - |
20 | | - # Whether running in container mode (installs dependencies if needed) |
21 | | - # Default: `false` |
22 | | - container: "false" |
23 | 45 | ``` |
24 | 46 |
|
| 47 | +<!-- usage:end --> |
| 48 | +<!-- inputs:start --> |
| 49 | +
|
25 | 50 | ## Inputs |
26 | 51 |
|
27 | | -| **Input** | **Description** | **Required** | **Default** | |
28 | | -| ----------------------- | ------------------------------------------------------------------- | ------------ | ----------- | |
29 | | -| **`working-directory`** | Working directory where coverage files are located. | **false** | `.` | |
30 | | -| **`container`** | Whether running in container mode (installs dependencies if needed) | **false** | `false` | |
| 52 | +| **Input** | **Description** | **Required** | **Default** | |
| 53 | +| ----------------------- | --------------------------------------------------- | ------------ | ----------- | |
| 54 | +| **`working-directory`** | Working directory where coverage files are located. | **false** | `.` | |
| 55 | +| | Can be absolute or relative to the repository root. | | | |
31 | 56 |
|
32 | | -## Features |
| 57 | +<!-- inputs:end --> |
| 58 | +<!-- secrets:start --> |
| 59 | +<!-- secrets:end --> |
| 60 | +<!-- outputs:start --> |
| 61 | +<!-- outputs:end --> |
| 62 | +<!-- examples:start --> |
| 63 | +<!-- examples:end --> |
| 64 | +<!-- contributing:start --> |
33 | 65 |
|
34 | | -- **Automatic dependency management**: In container mode, automatically detects and installs missing dependencies (Git, cURL, gnupg) using pkgxdev |
35 | | -- **Configuration fixes**: Automatically fixes pkgxdev configuration issues with unexpanded environment variables in gpgconf.ctl and .curlrc files |
36 | | -- **Cleanup**: Uninstalls dependencies after Codecov upload is complete |
37 | | -- **OIDC support**: Uses OIDC authentication with Codecov for secure uploads |
| 66 | +## Contributing |
| 67 | + |
| 68 | +Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) for more details. |
| 69 | + |
| 70 | +<!-- contributing:end --> |
| 71 | +<!-- security:start --> |
| 72 | +<!-- security:end --> |
| 73 | +<!-- license:start --> |
| 74 | + |
| 75 | +## License |
| 76 | + |
| 77 | +This project is licensed under the MIT License. |
| 78 | + |
| 79 | +SPDX-License-Identifier: MIT |
| 80 | + |
| 81 | +Copyright © 2025 hoverkraft |
| 82 | + |
| 83 | +For more details, see the [license](http://choosealicense.com/licenses/mit/). |
| 84 | + |
| 85 | +<!-- license:end --> |
| 86 | +<!-- generated:start --> |
| 87 | + |
| 88 | +--- |
| 89 | + |
| 90 | +This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor). |
| 91 | + |
| 92 | +<!-- generated:end --> |
0 commit comments