remove mention of yaml parameter

This commit is contained in:
ibrahim0814
2020-03-04 18:02:42 -08:00
parent 6ec347819d
commit 49c86d6a5f
4 changed files with 18 additions and 33519 deletions

View File

@@ -7,7 +7,7 @@
## Usage ## Usage
To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number as a `step` within your `workflow.yml` file. This Action also requires you to [provide an upload token](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) from [codecov.io](https://www.codecov.io) (tip: in order to avoid exposing your token, store it as a `secret`). Optionally, you can choose to include up to five additional inputs to customize the upload context. To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number as a `step` within your `workflow.yml` file. This Action also requires you to [provide an upload token](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) from [codecov.io](https://www.codecov.io) (tip: in order to avoid exposing your token, store it as a `secret`). Optionally, you can choose to include up to four additional inputs to customize the upload context.
Inside your `.github/workflows/workflow.yml` file: Inside your `.github/workflows/workflow.yml` file:
@@ -20,14 +20,13 @@ steps:
file: ./coverage.xml #optional file: ./coverage.xml #optional
flags: unittests #optional flags: unittests #optional
name: codecov-umbrella #optional name: codecov-umbrella #optional
yml: ./codecov.yml #optional
fail_ci_if_error: true #optional (default = false) fail_ci_if_error: true #optional (default = false)
``` ```
>**Note**: This assumes that you've set your Codecov token inside *Settings > Secrets* as `CODECOV_TOKEN`. If not, you can [get an upload token](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) for your specific repo on [codecov.io](https://www.codecov.io). Keep in mind that secrets are *not* available to forks of repositories. >**Note**: This assumes that you've set your Codecov token inside *Settings > Secrets* as `CODECOV_TOKEN`. If not, you can [get an upload token](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) for your specific repo on [codecov.io](https://www.codecov.io). Keep in mind that secrets are *not* available to forks of repositories.
## Arguments ## Arguments
Codecov's Action currently supports five inputs from the user: `token`, `file`, `flags`,`name`, `yml`, and `fail_ci_if_error`. These inputs, along with their descriptions and usage contexts, are listed in the table below: Codecov's Action currently supports five inputs from the user: `token`, `file`, `flags`,`name`, and `fail_ci_if_error`. These inputs, along with their descriptions and usage contexts, are listed in the table below:
| Input | Description | Usage | | Input | Description | Usage |
| :---: | :---: | :---: | | :---: | :---: | :---: |
@@ -35,7 +34,6 @@ Codecov's Action currently supports five inputs from the user: `token`, `file`,
| `file` | Path to the coverage report(s) | Optional | `file` | Path to the coverage report(s) | Optional
| `flags` | Flag the upload to group coverage metrics (unittests, uitests, etc.) | Optional | `flags` | Flag the upload to group coverage metrics (unittests, uitests, etc.) | Optional
| `name` | Custom defined name for the upload | Optional | `name` | Custom defined name for the upload | Optional
| `yml` | Path to codecov.yml config file | Optional
| `fail_ci_if_error` | Specify if CI pipeline should fail when Codecov runs into errors during upload. *Defaults to **false***. | Optional | `fail_ci_if_error` | Specify if CI pipeline should fail when Codecov runs into errors during upload. *Defaults to **false***. | Optional
### Example `workflow.yml` with Codecov Action ### Example `workflow.yml` with Codecov Action
@@ -67,7 +65,6 @@ jobs:
file: ./coverage.xml file: ./coverage.xml
flags: unittests flags: unittests
name: codecov-umbrella name: codecov-umbrella
yml: ./codecov.yml
fail_ci_if_error: true fail_ci_if_error: true
``` ```
## Contributing ## Contributing

View File

@@ -14,9 +14,6 @@ inputs:
flags: flags:
description: 'Flag upload to group coverage metrics (e.g. unittests | integration | ui,chrome)' description: 'Flag upload to group coverage metrics (e.g. unittests | integration | ui,chrome)'
required: false required: false
yml:
description: 'Specify the location of the .codecov.yml config file'
required: false
fail_ci_if_error: fail_ci_if_error:
description: 'Specify whether or not CI build should fail if Codecov runs into an error during upload' description: 'Specify whether or not CI build should fail if Codecov runs into an error during upload'
required: false required: false

33523
dist/index.js vendored

File diff suppressed because one or more lines are too long

View File

@@ -9,7 +9,6 @@ try {
const token = core.getInput("token"); const token = core.getInput("token");
const flags = core.getInput("flags"); const flags = core.getInput("flags");
const file = core.getInput("file"); const file = core.getInput("file");
const yml = core.getInput("yml");
fail_ci = core.getInput("fail_ci_if_error").toLowerCase(); fail_ci = core.getInput("fail_ci_if_error").toLowerCase();
if ( if (
@@ -68,8 +67,7 @@ try {
execArgs.push( execArgs.push(
"-n", `${name}`, "-n", `${name}`,
"-F", `${flags}`, "-F", `${flags}`
"-y", `${yml}`
); );
if (fail_ci) { if (fail_ci) {