You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,12 @@
2
2
3
3
:tada: Thanks for taking the time to contribute! :tada:
4
4
5
-
The following is a set of guidelines for contributing to this repository, which is hosted in the [Codecov Organization](https://github.com/codecov) on GitHub.
5
+
The following is a set of guidelines for contributing to this repository, which is hosted in the [Codecov Organization](https://github.com/codecov) on GitHub.
6
6
7
7
## What does this repo do?
8
8
9
-
This repo is a GitHub Action, meaning it integrates with the GitHub Actions CI/CD pipeline. It's meant to take formatted reports with code coverage stats and upload them to codecov.io. Our Node action uses the Actions toolkit to make system calls that allow us to run Codecov's bash uploader inside of Node. Essentially what we're doing in this action is downloading Codecov's bash uploader script from codecov.io/bash, saving it as a file in the current directory, executing the file via `exec` calls, then removing the script from the current directory.
9
+
This repo is a GitHub Action, meaning it integrates with the GitHub Actions CI/CD pipeline. It's meant to take formatted reports with code coverage stats and upload them to codecov.io. Our Node action uses the Actions toolkit to make system calls that allow us to run Codecov's bash uploader inside of Node. Essentially what we're doing in this action is downloading Codecov's bash uploader script from codecov.io/bash, saving it as a file in the current directory, executing the file via `exec` calls, then removing the script from the current directory.
10
10
11
11
## PRs, Issues, and Support
12
12
13
-
Feel free to clone, modify code and request a PR to this repository. All PRs and issues will be reviewed by the Codecov team. If your PR/issue has been sitting for a while or if you have any questions, ping us at [email protected]
13
+
Feel free to clone, modify code and request a PR to this repository. All PRs and issues will be reviewed by the Codecov team. If your PR/issue has been sitting for a while or if you have any questions, ping us at [email protected]
Copy file name to clipboardExpand all lines: README.md
+26-26
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,24 @@
7
7
8
8
>The latest release of this Action adds support for tokenless uploads from GitHub Actions!
9
9
10
+
## ⚠️ Deprecration of v1
11
+
**On February 1, 2022, this version will be fully sunset and no longer function**
12
+
13
+
Due to the [deprecation](https://about.codecov.io/blog/introducting-codecovs-new-uploader/) of the underlying bash uploader,
14
+
the Codecov GitHub Action has released `v2` which will use the new [uploader](https://github.com/codecov/uploader). You can learn
15
+
more about our deprecation plan and the new uploader on our [blog](https://about.codecov.io/blog/introducing-codecovs-new-uploader/).
16
+
17
+
We will be restricting any updates to the `v1` Action to security updates and hotfixes.
18
+
19
+
### Migration from `v1` to `v2`
20
+
The `v2` uploader has a few breaking changes for users
21
+
- Multiple fields have not been transferred from the bash uploader or have been deprecated. Notably
22
+
many of the `functionalities` and `gcov_` arguments have been removed. Please check the documentation
23
+
below for the full list.
24
+
10
25
## Usage
11
26
12
-
To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number (`@v1` is recommended) as a `step` within your `workflow.yml` file.
27
+
To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number (`@v2` is recommended) as a `step` within your `workflow.yml` file.
13
28
14
29
If you have a *private repository*, 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. **For public repositories, no token is needed**
15
30
@@ -18,7 +33,7 @@ Inside your `.github/workflows/workflow.yml` file:
18
33
```yaml
19
34
steps:
20
35
- uses: actions/checkout@master
21
-
- uses: codecov/codecov-action@v1
36
+
- uses: codecov/codecov-action@v2
22
37
with:
23
38
token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
24
39
files: ./coverage1.xml,./coverage2.xml # optional
@@ -38,29 +53,14 @@ Codecov's Action currently supports five inputs from the user: `token`, `file`,
38
53
| `token` | Used to authorize coverage report uploads | *Required for private repos* |
39
54
| `files` | Comma-separated paths to the coverage report(s) | Optional
40
55
| `directory` | Directory to search for coverage reports. | Optional
56
+
| `dry_run` | Don't upload files to Codecov | Optional
41
57
| `flags` | Flag the upload to group coverage metrics (unittests, uitests, etc.). Multiple flags are separated by a comma (ui,chrome) | Optional
42
58
| | |
43
-
| `aws_curl_args` | Extra curl arguments to communicate with AWS. | Optional
44
-
| `codecov_curl_args` | Extra curl arguments to communicate with Codecov. e.g., -U "--proxy http://http-proxy" | Optional
45
59
| `commit_parent` | The commit SHA of the parent for which you are uploading coverage. If not present, the parent will be determined using the API of your repository provider. When using the repository provider's API, the parent is determined via finding the closest ancestor to the commit. | Optional
46
60
| `env_vars` | Environment variables to tag the upload with. Multiple env variables can be separated with commas (e.g. `OS,PYTHON`) | Optional
47
61
| `fail_ci_if_error` | Specify if CI pipeline should fail when Codecov runs into errors during upload. *Defaults to **false*** | Optional
| `verbose` | Specify whether the Codecov output should be verbose | Optional
74
76
| `working-directory` | Directory in which to execute `codecov.sh` | Optional
75
-
| `xcode_derived_data` | Custom Derived Data Path for Coverage.profdata and gcov processing | Optional
76
-
| `xcode_package` | Specify packages to build coverage. Uploader will only build these packages. This can significantly reduces time to build coverage reports. -J 'MyAppName' Will match "MyAppName" and "MyAppNameTests" -J '^ExampleApp$' Will match only "ExampleApp" not "ExampleAppTests" | Optional
Copy file name to clipboardExpand all lines: action.yml
+9-36
Original file line number
Diff line number
Diff line change
@@ -14,15 +14,12 @@ inputs:
14
14
flags:
15
15
description: 'Flag upload to group coverage metrics (e.g. unittests | integration | ui,chrome)'
16
16
required: false
17
-
aws_curl_args:
18
-
description: 'Extra curl arguments to communicate with AWS.'
19
-
required: false
20
-
codecov_curl_args:
21
-
description: 'Extra curl arguments to communicate with Codecov. e.g., -U "--proxy http://http-proxy"'
22
-
required: false
23
17
commit_parent:
24
18
description: 'The commit SHA of the parent for which you are uploading coverage. If not present, the parent will be determined using the API of your repository provider. When using the repository providers API, the parent is determined via finding the closest ancestor to the commit.'
25
19
required: false
20
+
dry_run:
21
+
description: "Don't upload files to Codecov"
22
+
required: false
26
23
env_vars:
27
24
description: 'Environment variables to tag the upload with (e.g. PYTHON | OS,PYTHON)'
28
25
required: false
@@ -35,33 +32,12 @@ inputs:
35
32
functionalities:
36
33
description: 'Comma-separated list, see the README for options and their usage'
37
34
required: false
38
-
gcov_args:
39
-
description: 'extra arguments to pass to gcov'
40
-
required: false
41
-
gcov_executable:
42
-
description: 'gcov executable to run. Defaults to gcov'
43
-
required: false
44
-
gcov_path_exclude:
45
-
description: 'Paths to ignore during gcov gathering (as a glob)'
46
-
required: false
47
-
gcov_path_include:
48
-
description: 'Paths to include during gcov gathering (as a glob)'
49
-
required: false
50
-
gcov_prefix:
51
-
description: 'Prefix filepaths to help resolve path fixing'
52
-
required: false
53
-
gcov_root_dir:
54
-
description: 'Project root directory, also used when preparing gcov'
55
-
required: false
56
35
move_coverage_to_trash:
57
36
description: 'Move discovered coverage reports to the trash'
58
37
required: false
59
38
name:
60
39
description: 'User defined upload name. Visible in Codecov UI'
61
40
required: false
62
-
network_filter:
63
-
description: 'Used to restrict the set of git/hg files that can be matched with filenames in the coverage report. This is useful for monorepos or other setups where a full filepath may not be specified in the coverage report, and that shortened filepath may appear multiple times in a directory structure (e.g. __init__.py)'
64
-
required: false
65
41
override_branch:
66
42
description: 'Specify the branch name'
67
43
required: false
@@ -77,24 +53,21 @@ inputs:
77
53
override_tag:
78
54
description: 'Specify the git tag'
79
55
required: false
80
-
path_to_write_report:
81
-
description: 'Write upload file to path before uploading'
82
-
required: false
83
56
root_dir:
84
57
description: 'Used when not in git/hg project to identify project root directory'
85
58
required: false
59
+
slug:
60
+
description: 'Specify the slug manually (Enterprise use)'
61
+
required: false
62
+
url:
63
+
description: 'Change the upload host (Enterprise use)'
64
+
required: false
86
65
verbose:
87
66
description: 'Specify whether the Codecov output should be verbose'
88
67
required: false
89
68
working-directory:
90
69
description: 'Directory in which to execute codecov.sh'
91
70
required: false
92
-
xcode_derived_data:
93
-
description: 'Custom Derived Data Path for Coverage.profdata and gcov processing'
94
-
required: false
95
-
xcode_package:
96
-
description: 'Specify packages to build coverage. Uploader will only build these packages'
0 commit comments