Merge pull request #64 from samuelcolvin/env-vars

Env vars

.github/workflows/main.yml

@@ -1,23 +1,14 @@
 name: Example workflow for Codecov
-on: [push]
+on: [push, pull_request]
 jobs:
   run:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@master
-   
-#     - name: Setup Python  
-#       uses: actions/setup-python@master
-
-#     - name: Generate coverage report
-#       run: |
-#         pip install pytest
-#         pip install pytest-cov
-#         pytest --cov=./ --cov-report=xml
-
     - name: Upload coverage to Codecov  
       uses: ./
       with:
-        token: ${{secrets.CODECOV_TOKEN}}
+        #commenting out token because tokenless uploads are now supported
+        #token: ${{secrets.CODECOV_TOKEN}}
         flags: unittest
         name: codecov-1

README.md

@@ -1,13 +1,15 @@
-# Codecov GitHub Action 
+# Codecov GitHub Action
 
-[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-v1.0.5-undefined.svg?logo=github&logoColor=white&style=flat)](https://github.com/marketplace/actions/codecov)
+[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-v1-undefined.svg?logo=github&logoColor=white&style=flat)](https://github.com/marketplace/actions/codecov)
-### Easily upload coverage reports to Codecov from GitHub Actions 
+### Easily upload coverage reports to Codecov from GitHub Actions
 
->The latest release of this Action adds support for macOS and Windows builds!
+>The latest release of this Action adds support for tokenless uploads from GitHub Actions!
 
 ## 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 (`@v1` 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**
 
 Inside your `.github/workflows/workflow.yml` file:
 
@@ -16,27 +18,28 @@ steps:
 - uses: actions/checkout@master
 - uses: codecov/codecov-action@v1
   with:
-    token: ${{ secrets.CODECOV_TOKEN }} #required
+    token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
-    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). 
+>**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
 
-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:
+
+>**Update**: We've removed the `yml` parameter with the latest release of this action. Please put your custom codecov yaml file at the root of the repo because other locations will no longer be supported in the future.
 
 | Input  | Description | Usage |
 | :---:     |     :---:   |    :---:   |
-| `token`  | Used to authorize coverage report uploads  | *Required* |
+| `token`  | Used to authorize coverage report uploads  | *Required for private repos* |
 | `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.). Multiple flags are separated by a comma (ui,chrome) | Optional
+| `env_vars`  | Environment variables to tag the upload with. Multiple env variables can be separated with commas (e.g. `OS,PYTHON`) | 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
 
@@ -47,11 +50,14 @@ jobs:
   run:
     runs-on: ${{ matrix.os }}
     strategy:
-      matrix: 
+      matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: '3.7'
     steps:
     - uses: actions/checkout@master
-    - name: Setup Python  
+    - name: Setup Python
       uses: actions/setup-python@master
       with:
         python-version: 3.7
@@ -60,20 +66,20 @@ jobs:
         pip install pytest
         pip install pytest-cov
         pytest --cov=./ --cov-report=xml
-    - name: Upload coverage to Codecov  
+    - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v1
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         file: ./coverage.xml
         flags: unittests
+        env_vars: OS,PYTHON
         name: codecov-umbrella
-        yml: ./codecov.yml 
         fail_ci_if_error: true
 ```
 ## Contributing
 
 Contributions are welcome! Check out the [Contribution Guide](CONTRIBUTING.md).
 
-## License 
+## License
 
 The code in this project is released under the [MIT License](LICENSE).

action.yml

@@ -1,29 +1,28 @@
 name: 'Codecov'
 description: 'GitHub Action that uploads coverage reports for your repository to codecov.io'
 author: 'Ibrahim Ali <@ibrahim0814> | Codecov'
-inputs: 
+inputs:
   name:
     description: 'User defined upload name. Visible in Codecov UI'
-    required: false 
+    required: false
   token:
-    description: 'Repository upload token - get it from codecov.io'
+    description: 'Repository upload token - get it from codecov.io. Required only for private repositories'
-    required: true 
+    required: false
   file:
     description: 'Path to coverage file to upload'
     required: false
   flags:
     description: 'Flag upload to group coverage metrics (e.g. unittests | integration | ui,chrome)'
     required: false
-  yml:
+  env_vars:
-    description: 'Specify the location of the .codecov.yml config file'
+    description: 'Environment variables to tag the upload with (e.g. PYTHON | OS,PYTHON)'
     required: false
   fail_ci_if_error:
     description: 'Specify whether or not CI build should fail if Codecov runs into an error during upload'
     required: false
 branding:
-  color: 'red' 
+  color: 'red'
   icon: 'umbrella'
 runs:
   using: 'node12'
   main: 'dist/index.js'
-   

index.js

@@ -9,7 +9,8 @@ try {
   const token = core.getInput("token");
   const flags = core.getInput("flags");
   const file = core.getInput("file");
-  const yml = core.getInput("yml");
+  const env_vars = core.getInput("env_vars");
+  
   fail_ci = core.getInput("fail_ci_if_error").toLowerCase();
 
   if (
@@ -50,106 +51,66 @@ try {
         }
       };
 
-      options.env = {
+      options.env = Object.assign(process.env, {
-        CODECOV_TOKEN: `${token}`,
         GITHUB_ACTION: process.env.GITHUB_ACTION,
+        GITHUB_RUN_ID: process.env.GITHUB_RUN_ID,
         GITHUB_REF: process.env.GITHUB_REF,
         GITHUB_REPOSITORY: process.env.GITHUB_REPOSITORY,
-        GITHUB_SHA: process.env.GITHUB_SHA
+        GITHUB_SHA: process.env.GITHUB_SHA,
-      };
+        GITHUB_HEAD_REF: process.env.GITHUB_HEAD_REF || ''
+      });
 
-      if (file) {
+      if(token){
-        if (fail_ci) {
+        options.env.CODECOV_TOKEN = token
-          exec
+      }
-            .exec(
+
-              "bash",
+      const env_vars_arg = []
-              [
+      for (let env_var of env_vars.split(",")) {
-                "codecov.sh",
+        let env_var_clean = env_var.trim();
-                "-f",
+        if (env_var_clean) {
-                `${file}`,
+          options.env[env_var_clean] = process.env[env_var_clean];
-                "-n",
+          env_vars_arg.push(env_var_clean)
-                `${name}`,
-                "-F",
-                `${flags}`,
-                "-y",
-                `${yml}`,
-                "-Z"
-              ],
-              options
-            )
-            .catch(err => {
-              core.setFailed(
-                `Codecov failed with the following error: ${err.message}`
-              );
-            })
-            .then(() => {
-              unlinkFile();
-            });
-        } else {
-          exec
-            .exec(
-              "bash",
-              [
-                "codecov.sh",
-                "-f",
-                `${file}`,
-                "-n",
-                `${name}`,
-                "-F",
-                `${flags}`,
-                "-y",
-                `${yml}`
-              ],
-              options
-            )
-            .catch(err => {
-              core.warning(`Codecov warning: ${err.message}`);
-            })
-            .then(() => {
-              unlinkFile();
-            });
-        }
-      } else {
-        if (fail_ci) {
-          exec
-            .exec(
-              "bash",
-              [
-                "codecov.sh",
-                "-n",
-                `${name}`,
-                "-F",
-                `${flags}`,
-                "-y",
-                `${yml}`,
-                "-Z"
-              ],
-              options
-            )
-            .catch(err => {
-              core.setFailed(
-                `Codecov failed with the following error: ${err.message}`
-              );
-            })
-            .then(() => {
-              unlinkFile();
-            });
-        } else {
-          exec
-            .exec(
-              "bash",
-              ["codecov.sh", "-n", `${name}`, "-F", `${flags}`, "-y", `${yml}`],
-              options
-            )
-            .catch(err => {
-              core.warning(`Codecov warning: ${err.message}`);
-            })
-            .then(() => {
-              unlinkFile();
-            });
         }
       }
 
+      const execArgs = ["codecov.sh"];
+      if (file) {
+        execArgs.push(
+          "-f", `${file}`
+        );
+      }
+
+      execArgs.push(
+        "-n", `${name}`,
+        "-F", `${flags}`
+      );
+
+      if (fail_ci) {
+        execArgs.push(
+          "-Z"
+        );
+      }
+
+      if (env_vars_arg.length) {
+        execArgs.push(
+          "-e", env_vars_arg.join(",")
+        );
+      }
+
+      exec.exec("bash", execArgs, options)
+        .catch(err => {
+          if (fail_ci) {
+            core.setFailed(
+              `Codecov failed with the following error: ${err.message}`
+            );
+          } else {
+            core.warning(`Codecov warning: ${err.message}`);
+          }
+        })
+        .then(() => {
+          unlinkFile();
+        });
+
       const unlinkFile = () => {
         fs.unlink("codecov.sh", err => {
           if (err && fail_ci) {

package-lock.json

@@ -1,6 +1,6 @@
 {
-  "name": "test2",
+  "name": "codecov-action",
-  "version": "1.0.0",
+  "version": "1.0.5",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -12,8 +12,8 @@
     "url": "git+https://github.com/codecov/codecov-action.git"
   },
   "keywords": [],
-  "author": "",
+  "author": "Ibrahim Ali",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/codecov/codecov-action/issues"
   },
@@ -24,5 +24,6 @@
     "@zeit/ncc": "^0.20.5",
     "fs": "0.0.1-security",
     "request": "^2.88.0"
-  }
+  },
+  "devDependencies": {}
 }