Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ericcornelissen/codecov-config-validator-action
Action for validating Codecov configuration files
https://github.com/ericcornelissen/codecov-config-validator-action
actions codecov
Last synced: about 4 hours ago
JSON representation
Action for validating Codecov configuration files
- Host: GitHub
- URL: https://github.com/ericcornelissen/codecov-config-validator-action
- Owner: ericcornelissen
- License: mpl-2.0
- Created: 2022-12-04T12:51:49.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-13T10:49:36.000Z (5 months ago)
- Last Synced: 2024-06-13T13:31:10.270Z (5 months ago)
- Topics: actions, codecov
- Language: Shell
- Homepage:
- Size: 113 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Codecov Config Validator Action
A GitHub action to validate [Codecov] configuration files.
> [!WARNING]
> Support for this Action ended 2024-10-11. We recommend finding an alternative
> and to not start nor continue using this Action.
## Usage
```yml
- uses: actions/checkout@v4
- uses: ericcornelissen/codecov-config-validator-action@v1
with:
# Provide a path to the location of the Codecov configuration file.
#
# Default: ".github/codecov.yml"
# Required: false
file: path/to/codecov.yml
```
### Recommended Workflow
This workflow is recommended because it minimizes how often the Codecov config
is validated.
```yml
# .github/workflows/config-codecov.yml
name: Codecov Config
on:
pull_request:
paths:
- .github/workflows/config-codecov.yml
- .github/codecov.yml
push:
branches:
- main # default branch
paths:
- .github/workflows/config-codecov.yml
- .github/codecov.yml
permissions: read-all
jobs:
validate:
name: Validate
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ericcornelissen/codecov-config-validator-action@v1
with:
file: .github/codecov.yml
```
## Outputs
_See the [steps context] documentation for how to use output values._
- `status-code`: The HTTP status code returned by the Codecov API.
## Runners
This action is tested on the official [`ubuntu-20.04`] and [`ubuntu-22.04`]
runner images. It is recommended to use one of these images when using this
action.
## Security
### Permissions
This Action requires no [permissions].
### Network
This Action requires network access to the endpoint `codecov.io:443`.
## License
All source code is licensed under the Mozilla Public License 2.0 license, see
[LICENSE] for the full license text. The contents of documentation is licensed
under [CC BY-SA 4.0].
---
Please [open an issue] if you found a mistake or if you have a suggestion for
how to improve the documentation.
[cc by-sa 4.0]: https://creativecommons.org/licenses/by-sa/4.0/
[codecov]: https://codecov.io/
[license]: ./LICENSE
[open an issue]: https://github.com/ericcornelissen/codecov-config-validator-action/issues/new?labels=documentation
[permissions]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions
[steps context]: https://docs.github.com/en/actions/learn-github-actions/contexts#steps-context
[`ubuntu-20.04`]: https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2004-Readme.md
[`ubuntu-22.04`]: https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2204-Readme.md