Merge pull request #392 from codecov/v2

feat: Use new Codecov uploader

.eslintrc.json

@@ -5,7 +5,9 @@
         "es2021": true
     },
     "extends": [
-        "google"
+        "google",
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
     ],
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
@@ -15,5 +17,6 @@
         "@typescript-eslint"
     ],
     "rules": {
+        "linebreak-style": 0
     }
 }

.github/workflows/main.yml

@@ -2,7 +2,10 @@ name: Workflow for Codecov Action
 on: [push, pull_request]
 jobs:
   run:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -12,16 +15,16 @@ jobs:
         run: npm run lint
       - name: Run tests and collect coverage
         run: npm run test
+      - name: Upload coverage to Codecov (script)
+        uses: ./
+        with:
+          files: ./coverage/script/coverage-final.json
+          flags: script,${{ matrix.os }}
+          name: codecov-script
       - name: Upload coverage to Codecov (demo)
         uses: ./
         with:
           files: ./coverage/calculator/coverage-final.json,./coverage/coverage-test/coverage-final.json
           file: ./coverage/coverage-final.json
-          flags: demo
+          flags: demo,${{ matrix.os }}
           name: codecov-demo
-      - name: Upload coverage to Codecov (script)
-        uses: ./
-        with:
-          files: ./coverage/script/coverage-final.json
-          flags: script
-          name: codecov-script

CHANGELOG.md

@@ -1,3 +1,19 @@
+## 2.0.0
+On February 1, 2022, the `v1` uploader will be full sunset and no longer function. This is due
+to the deprecation of the underlying bash uploader. This version uses the new [uploader](https://github.com/codecov/uploader).
+
+The `v2` Action downloads, verifies, and runs the Codecov binary.
+
+### Breaking Changes
+- Multiple fields have not been transferred from the bash uploader or have been deprecated. Notably
+many of the `functionalities` and `gcov_` arguments have been removed. Please check the documentation
+for the full list.
+
+### Features
+- `dry-run` argument allows Codecov flow without uploading reports to Codecov
+- (Enterprise only) `slug` allows specifying the repository slug manually
+- (Enterprise only) `url` allows changing the upload host
+
 ## 1.5.2
 ### Fixes
 - # fix: Import version properly as string not object

CONTRIBUTING.md

@@ -2,12 +2,12 @@
 
 :tada: Thanks for taking the time to contribute! :tada:
 
-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. 
+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.
 
 ## What does this repo do?
 
-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. 
+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.
 
 ## PRs, Issues, and Support
 
-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] 
+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]

README.md

@@ -7,9 +7,24 @@
 
 >The latest release of this Action adds support for tokenless uploads from GitHub Actions!
 
+## ⚠️  Deprecration of v1
+**On February 1, 2022, this version will be fully sunset and no longer function**
+
+Due to the [deprecation](https://about.codecov.io/blog/introducting-codecovs-new-uploader/) of the underlying bash uploader,
+the Codecov GitHub Action has released `v2` which will use the new [uploader](https://github.com/codecov/uploader). You can learn
+more about our deprecation plan and the new uploader on our [blog](https://about.codecov.io/blog/introducing-codecovs-new-uploader/).
+
+We will be restricting any updates to the `v1` Action to security updates and hotfixes.
+
+### Migration from `v1` to `v2`
+The `v2` uploader has a few breaking changes for users
+- Multiple fields have not been transferred from the bash uploader or have been deprecated. Notably
+many of the `functionalities` and `gcov_` arguments have been removed. Please check the documentation
+below for the full list.
+
 ## Usage
 
-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.
+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.
 
 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**
 
@@ -18,7 +33,7 @@ Inside your `.github/workflows/workflow.yml` file:
 ```yaml
 steps:
 - uses: actions/checkout@master
-- uses: codecov/codecov-action@v1
+- uses: codecov/codecov-action@v2
   with:
     token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
     files: ./coverage1.xml,./coverage2.xml # optional
@@ -38,29 +53,14 @@ Codecov's Action currently supports five inputs from the user: `token`, `file`,
 | `token`  | Used to authorize coverage report uploads  | *Required for private repos* |
 | `files`  | Comma-separated paths to the coverage report(s) | Optional
 | `directory` | Directory to search for coverage reports. | Optional
+| `dry_run` | Don't upload files to Codecov | Optional
 | `flags`  | Flag the upload to group coverage metrics (unittests, uitests, etc.). Multiple flags are separated by a comma (ui,chrome) | Optional
 | | |
-| `aws_curl_args` | Extra curl arguments to communicate with AWS. | Optional
-| `codecov_curl_args` | Extra curl arguments to communicate with Codecov. e.g., -U "--proxy http://http-proxy" | Optional
 | `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
 | `env_vars`  | Environment variables to tag the upload with. Multiple env variables can be separated with commas (e.g. `OS,PYTHON`) | Optional
 | `fail_ci_if_error`  | Specify if CI pipeline should fail when Codecov runs into errors during upload. *Defaults to **false*** | Optional
-| `functionalities` | Toggle functionalities | Optional
-| | `coveragepy` Disable python coverage |
-| | `fix` Disable report fixing |
-| | `gcov` Disable gcov |
-| | `gcovout` Disable gcov output |
-| | `html` Enable coverage for HTML files |
-| | `network` Disable uploading the file network |
-| | `recursesubs` Enable recurse submodules in git projects when searching for source files | |
-| | `search` Disable searching for reports |
-| | `xcode` Disable xcode processing |
-| `gcov_path_include` | Paths to include during gcov gathering (as a glob) | Optional
-| `gcov_args` | extra arguments to pass to gcov | Optional
-| `gcov_executable` | gcov executable to run. Defaults to 'gcov' | Optional
-| `gcov_path_exclude` | Paths to ignore during gcov gathering (as a glob) | Optional
-| `gcov_prefix` | Prefix filepaths to help resolve path fixing | Optional
-| `gcov_root_dir` | Project root directory, also used when preparing gcov | Optional
+-| `functionalities` | Toggle functionalities | Optional
+-| | `network` Disable uploading the file network |
 | `move_coverage_to_trash` | Move discovered coverage reports to the trash | Optional
 | `name`  | Custom defined name for the upload | Optional
 | `override_branch` | Specify the branch name | Optional
@@ -70,10 +70,10 @@ Codecov's Action currently supports five inputs from the user: `token`, `file`,
 | `override_tag` | Specify the git tag | Optional
 | `path_to_write_report` | Write upload file to path before uploading | Optional
 | `root_dir` | Used when not in git/hg project to identify project root directory | Optional
+| `slug` | Specify the slug manually (Enterprise use) | Optional
+| `url` | Change the upload host (Enterprise use) | Optional
 | `verbose` | Specify whether the Codecov output should be verbose | Optional
 | `working-directory` | Directory in which to execute `codecov.sh` | Optional
-| `xcode_derived_data` | Custom Derived Data Path for Coverage.profdata and gcov processing | Optional
-| `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
 
 ### Example `workflow.yml` with Codecov Action
 
@@ -101,15 +101,15 @@ jobs:
         pip install pytest-cov
         pytest --cov=./ --cov-report=xml
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v1
+      uses: codecov/codecov-action@v2
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
-        files: ./coverage1.xml,./coverage2.xml
         directory: ./coverage/reports/
-        flags: unittests
         env_vars: OS,PYTHON
-        name: codecov-umbrella
         fail_ci_if_error: true
+        files: ./coverage1.xml,./coverage2.xml
+        flags: unittests
+        name: codecov-umbrella
         path_to_write_report: ./coverage/codecov_report.txt
         verbose: true
 ```
@@ -121,5 +121,4 @@ Contributions are welcome! Check out the [Contribution Guide](CONTRIBUTING.md).
 
 The code in this project is released under the [MIT License](LICENSE).
 
-
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-action.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-action?ref=badge_large)

action.yml

@@ -14,15 +14,12 @@ inputs:
   flags:
     description: 'Flag upload to group coverage metrics (e.g. unittests | integration | ui,chrome)'
     required: false
-  aws_curl_args:
-    description: 'Extra curl arguments to communicate with AWS.'
-    required: false
-  codecov_curl_args:
-    description: 'Extra curl arguments to communicate with Codecov. e.g., -U "--proxy http://http-proxy"'
-    required: false
   commit_parent:
     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.'
     required: false
+  dry_run:
+    description: "Don't upload files to Codecov"
+    required: false
   env_vars:
     description: 'Environment variables to tag the upload with (e.g. PYTHON | OS,PYTHON)'
     required: false
@@ -35,33 +32,12 @@ inputs:
   functionalities:
     description: 'Comma-separated list, see the README for options and their usage'
     required: false
-  gcov_args:
-    description: 'extra arguments to pass to gcov'
-    required: false
-  gcov_executable:
-    description: 'gcov executable to run. Defaults to gcov'
-    required: false
-  gcov_path_exclude:
-    description: 'Paths to ignore during gcov gathering (as a glob)'
-    required: false
-  gcov_path_include:
-    description: 'Paths to include during gcov gathering (as a glob)'
-    required: false
-  gcov_prefix:
-    description: 'Prefix filepaths to help resolve path fixing'
-    required: false
-  gcov_root_dir:
-    description: 'Project root directory, also used when preparing gcov'
-    required: false
   move_coverage_to_trash:
     description: 'Move discovered coverage reports to the trash'
     required: false
   name:
     description: 'User defined upload name. Visible in Codecov UI'
     required: false
-  network_filter:
-    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)'
-    required: false
   override_branch:
     description: 'Specify the branch name'
     required: false
@@ -77,24 +53,21 @@ inputs:
   override_tag:
     description: 'Specify the git tag'
     required: false
-  path_to_write_report:
-    description: 'Write upload file to path before uploading'
-    required: false
   root_dir:
     description: 'Used when not in git/hg project to identify project root directory'
     required: false
+  slug:
+    description: 'Specify the slug manually (Enterprise use)'
+    required: false
+  url:
+    description: 'Change the upload host (Enterprise use)'
+    required: false
   verbose:
     description: 'Specify whether the Codecov output should be verbose'
     required: false
   working-directory:
     description: 'Directory in which to execute codecov.sh'
     required: false
-  xcode_derived_data:
-    description: 'Custom Derived Data Path for Coverage.profdata and gcov processing'
-    required: false
-  xcode_package:
-    description: 'Specify packages to build coverage. Uploader will only build these packages'
-    required: false
 branding:
   color: 'red'
   icon: 'umbrella'