Compare commits

..

58 Commits

Author SHA1 Message Date
Thomas Hu
5d3f01ccdc Up the number of attempts 2020-08-17 17:14:51 -04:00
Thomas Hu
2d80980946 Add more timeouts and sharter timeout 2020-08-17 17:05:37 -04:00
Thomas Hu
fadbb25281 Merge pull request #109 from ibrahim0814/patch-1
Update action.yml with new authors
2020-08-12 13:09:38 -04:00
Ibrahim Ali
ad774549da Update action.yml with new authors
Add Thomas Hu as new author 👍
2020-08-12 00:15:12 -07:00
Thomas Hu
07127fde53 Merge pull request #97 from codecov/dependabot/npm_and_yarn/lodash-4.17.19
Bump lodash from 4.17.15 to 4.17.19
2020-07-22 09:57:50 -04:00
dependabot[bot]
9128542d5d Bump lodash from 4.17.15 to 4.17.19
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.15...4.17.19)

Signed-off-by: dependabot[bot] <support@github.com>
2020-07-17 18:34:08 +00:00
Thomas Hu
6d208f5b52 Merge pull request #96 from codecov/1.0.12
Wrap request promise in try catch
2020-07-17 14:33:32 -04:00
Thomas Hu
8ddda09c14 Wrap request promise in try catch 2020-07-17 11:57:18 -04:00
Thomas Hu
e16d515d3b Merge pull request #90 from codecov/directory-and-debug
Add directory and file save
2020-07-13 13:21:09 -04:00
Thomas Hu
6b30325ebb Merge branch 'master' into directory-and-debug 2020-07-13 13:00:02 -04:00
Thomas Hu
95f699a0a9 Merge pull request #94 from codecov/update-readme
Add files to README
2020-07-10 17:53:16 -04:00
Thomas Hu
273443b325 Add files to README 2020-07-10 15:32:51 -04:00
Thomas Hu
a258ec8bb8 Merge pull request #93 from codecov/specify-files
Specify files and add testing
2020-07-10 15:31:03 -04:00
Thomas Hu
89692c91b7 Specify files and add testing 2020-07-09 23:07:34 -04:00
Thomas Hu
85ec2c8d83 Add directory and file save 2020-07-07 22:36:09 -04:00
Thomas Hu
f3570723ef Merge pull request #89 from codecov/fix-ependency
Fix dependencies
2020-07-01 16:43:21 -04:00
Thomas Hu
f40f110376 Try requestretry 2020-07-01 15:47:57 -04:00
Thomas Hu
4f81def87b Upgrade ncc 2020-07-01 15:35:39 -04:00
Thomas Hu
ddc46b3107 Fix dependencies 2020-07-01 14:58:11 -04:00
Thomas Hu
1b088680d5 Fix dependencies 2020-07-01 14:48:26 -04:00
Thomas Hu
22f6ff10ac Merge pull request #88 from codecov/update-dist
Update dist
2020-07-01 11:57:59 -04:00
Thomas Hu
0ceca4b5d3 Install dependencies 2020-07-01 11:51:01 -04:00
Thomas Hu
3658bafacb Bump version 2020-07-01 11:45:18 -04:00
Thomas Hu
ef3b48314f Update dist 2020-07-01 11:40:05 -04:00
Thomas Hu
dbf1ddee08 Merge pull request #87 from codecov/retry-bash
Retry retrieval of bash script
2020-07-01 07:27:35 -04:00
Thomas Hu
cc6b0c11d2 Retry retrieval of bash script 2020-06-30 23:33:46 -04:00
Thomas Hu
f532c3a145 Merge pull request #64 from samuelcolvin/env-vars
Env vars
2020-05-06 17:35:02 -04:00
Thomas Hu
143333ba90 Merge pull request #67 from alex/patch-1
Fixes #66 -- include the current env when invoking the subprocess
2020-05-06 17:33:54 -04:00
Thomas Hu
a50851cfd8 Merge pull request #72 from christophebedard/fix-typo-readme
Fix typo in README
2020-05-06 17:32:30 -04:00
Thomas Hu
6914527afb Update index.js 2020-05-06 17:28:51 -04:00
Christophe Bedard
fff75f1901 Fix typo in README 2020-05-03 10:22:07 -04:00
Samuel Colvin
1804a456ff fix typos 2020-04-04 14:01:58 +01:00
Alex Gaynor
d1b4c72fc5 Update index.js 2020-03-21 20:47:24 -04:00
Alex Gaynor
6fd09f835d Fixes #66 -- include the current env when invoking the subprocess 2020-03-21 20:47:04 -04:00
Samuel Colvin
e866b3854d add docs 2020-03-20 16:05:53 +00:00
Samuel Colvin
608816e426 remove log statements 2020-03-20 11:27:29 +00:00
Samuel Colvin
2ce3b3807d rebuild dist 2020-03-20 11:21:50 +00:00
Samuel Colvin
0e6a911c9b add '-e' flag 2020-03-19 16:46:53 +00:00
Samuel Colvin
d04135f7cf debug log 2020-03-19 16:39:42 +00:00
Samuel Colvin
7938e79f4c adding 'env_vars' input option 2020-03-19 16:31:53 +00:00
Ibrahim Ali
a3a6becb2c Update README.md 2020-03-07 00:00:34 -08:00
Ibrahim Ali
bf0e754c09 Update README.md 2020-03-07 00:00:14 -08:00
Ibrahim Ali
daa5098552 update latest version line on readme 2020-03-06 23:59:58 -08:00
Ibrahim Ali
71d5dea6af Add example for how to specify multiple flags 2020-03-05 00:00:10 -08:00
ibrahim0814
e34ee48524 remove sample coverage file 2020-03-04 22:37:01 -08:00
Ibrahim Ali
d7c91c57ee Merge pull request #53 from armano2/branch-support
Add support for pull requests and tokenless uploads
2020-03-04 22:24:12 -08:00
ibrahim0814
d9faadf52a more documentation updates 2020-03-04 22:22:38 -08:00
ibrahim0814
c70450d006 revert alt exec cmd 2020-03-04 22:02:07 -08:00
ibrahim0814
a6d365dd4c syntax error fix 2020-03-04 21:59:13 -08:00
ibrahim0814
94278ffe1b test alternate exec cmd 2020-03-04 21:57:29 -08:00
ibrahim0814
ebea5cacdf add more documentation notes 2020-03-04 19:59:17 -08:00
ibrahim0814
6a65fa4d50 add github run id env variable 2020-03-04 19:11:12 -08:00
ibrahim0814
4623a4dc3d add sample coverage files 2020-03-04 18:55:36 -08:00
ibrahim0814
c98408608b add functionality for tokenless 2020-03-04 18:30:14 -08:00
ibrahim0814
49c86d6a5f remove mention of yaml parameter 2020-03-04 18:02:42 -08:00
Armano
6ec347819d chore: set GITHUB_HEAD_REF to empty string if not present 2020-02-09 23:38:15 +01:00
Armano
44ca3d2c84 simplify code and add missing GITHUB_HEAD_REF 2020-02-07 22:24:55 +01:00
Ibrahim Ali
66879ff350 add forked repo secrets notice to readme 2019-12-18 18:50:35 -08:00
13 changed files with 51970 additions and 26510 deletions

View File

@@ -1,23 +1,19 @@
name: Example workflow for Codecov
on: [push]
name: Workflow for Codecov Action
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}}
flags: unittest
name: codecov-1
- name: Checkout
uses: actions/checkout@master
- name: Install dependencies
run: npm install
- name: Run tests and collect coverage
run: yarn run test-all
- name: Upload coverage to Codecov
uses: ./
with:
files: ./coverage/calculator/coverage-final.json,./coverage/index/coverage-final.json
file: ./coverage/coverage-final.json
flags: unittest
name: codecov-1

View File

@@ -1,6 +1,6 @@
MIT License
Copyright (c) 2019 Codecov
Copyright (c) 2019-2020 Codecov
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@@ -1,13 +1,15 @@
# 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
>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,32 @@ steps:
- uses: actions/checkout@master
- uses: codecov/codecov-action@v1
with:
token: ${{ secrets.CODECOV_TOKEN }} #required
file: ./coverage.xml #optional
flags: unittests #optional
name: codecov-umbrella #optional
yml: ./codecov.yml #optional
fail_ci_if_error: true #optional (default = false)
token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
file: ./coverage.xml # optional
files: ./coverage1.xml,./coverage2.xml # optional
flags: unittests # optional
name: codecov-umbrella # optional
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
| `files` | Comma-separated paths to the coverage report(s) | Optional
| `directory` | Directory to search for coverage reports. | 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
| `path_to_write_report` | Write upload file to path before uploading | Optional
### Example `workflow.yml` with Codecov Action
@@ -49,6 +56,9 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
env:
OS: ${{ matrix.os }}
PYTHON: '3.7'
steps:
- uses: actions/checkout@master
- name: Setup Python
@@ -65,10 +75,13 @@ jobs:
with:
token: ${{ secrets.CODECOV_TOKEN }}
file: ./coverage.xml
files: ./coverage1.xml,./coverage2.xml
directory: ./coverage/reports/
flags: unittests
env_vars: OS,PYTHON
name: codecov-umbrella
yml: ./codecov.yml
fail_ci_if_error: true
path_to_write_report: ./coverage/codecov_report.gz
```
## Contributing

View File

@@ -1,21 +1,30 @@
name: 'Codecov'
description: 'GitHub Action that uploads coverage reports for your repository to codecov.io'
author: 'Ibrahim Ali <@ibrahim0814> | Codecov'
author: 'Ibrahim Ali <@ibrahim0814> & Thomas Hu <@thomasrockhu> | Codecov'
inputs:
name:
description: 'User defined upload name. Visible in Codecov UI'
required: false
token:
description: 'Repository upload token - get it from codecov.io'
required: true
description: 'Repository upload token - get it from codecov.io. Required only for private repositories'
required: false
file:
description: 'Path to coverage file to upload'
required: false
files:
description: 'Comma-separated list of files to upload'
required: false
directory:
description: 'Directory to search for coverage reports.'
required: false
flags:
description: 'Flag upload to group coverage metrics (e.g. unittests | integration | ui,chrome)'
required: false
yml:
description: 'Specify the location of the .codecov.yml config file'
path_to_write_report:
description: 'Write upload file to path before uploading'
required: false
env_vars:
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'
@@ -26,4 +35,3 @@ branding:
runs:
using: 'node12'
main: 'dist/index.js'

73101
dist/index.js vendored

File diff suppressed because one or more lines are too long

259
index.js
View File

@@ -1,7 +1,7 @@
const core = require("@actions/core");
const exec = require("@actions/exec");
const request = require("request");
const fs = require("fs");
const request = require('requestretry');
let fail_ci;
try {
@@ -9,7 +9,11 @@ try {
const token = core.getInput("token");
const flags = core.getInput("flags");
const file = core.getInput("file");
const yml = core.getInput("yml");
const files = core.getInput("files");
const env_vars = core.getInput("env_vars");
const dir = core.getInput("directory");
const write_path = core.getInput("path_to_write_report");
fail_ci = core.getInput("fail_ci_if_error").toLowerCase();
if (
@@ -24,142 +28,133 @@ try {
fail_ci = false;
}
request("https://codecov.io/bash", (error, response, body) => {
if (error && fail_ci) {
throw error;
} else if (error) {
core.warning(`Codecov warning: ${error.message}`);
}
fs.writeFile("codecov.sh", body, err => {
if (err && fail_ci) {
throw err;
} else if (err) {
core.warning(`Codecov warning: ${err.message}`);
request({
json: false,
maxAttempts: 10,
timeout: 3000,
url: "https://codecov.io/bash"
}, (error, response, body) => {
try {
if (error && fail_ci) {
throw error;
} else if (error) {
core.warning(`Codecov warning: ${error.message}`);
}
let output = "";
let execError = "";
const options = {};
options.listeners = {
stdout: data => {
output += data.toString();
},
stderr: data => {
execError += data.toString();
fs.writeFile("codecov.sh", body, err => {
if (err && fail_ci) {
throw err;
} else if (err) {
core.warning(`Codecov warning: ${err.message}`);
}
};
options.env = {
CODECOV_TOKEN: `${token}`,
GITHUB_ACTION: process.env.GITHUB_ACTION,
GITHUB_REF: process.env.GITHUB_REF,
GITHUB_REPOSITORY: process.env.GITHUB_REPOSITORY,
GITHUB_SHA: process.env.GITHUB_SHA
};
if (file) {
if (fail_ci) {
exec
.exec(
"bash",
[
"codecov.sh",
"-f",
`${file}`,
"-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",
"-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 unlinkFile = () => {
fs.unlink("codecov.sh", err => {
if (err && fail_ci) {
throw err;
} else if (err) {
core.warning(`Codecov warning: ${err.message}`);
let output = "";
let execError = "";
const options = {};
options.listeners = {
stdout: data => {
output += data.toString();
},
stderr: data => {
execError += data.toString();
}
};
options.env = Object.assign(process.env, {
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_HEAD_REF: process.env.GITHUB_HEAD_REF || ''
});
};
});
if(token){
options.env.CODECOV_TOKEN = token
}
const env_vars_arg = []
for (let env_var of env_vars.split(",")) {
let env_var_clean = env_var.trim();
if (env_var_clean) {
options.env[env_var_clean] = process.env[env_var_clean];
env_vars_arg.push(env_var_clean)
}
}
const execArgs = ["codecov.sh"];
if (file) {
execArgs.push(
"-f", `${file}`
);
}
if (files) {
files.split(',').forEach(f => {
execArgs.push(
"-f", `${f}`
);
});
}
if (dir) {
execArgs.push(
"-s", `${dir}`
);
}
execArgs.push(
"-n", `${name}`,
"-F", `${flags}`
);
if (fail_ci) {
execArgs.push(
"-Z"
);
}
if (env_vars_arg.length) {
execArgs.push(
"-e", env_vars_arg.join(",")
);
}
if (write_path) {
execArgs.push(
"-q", `${write_path}`
);
}
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) {
throw err;
} else if (err) {
core.warning(`Codecov warning: ${err.message}`);
}
});
};
});
} catch (error) {
core.setFailed(
`Codecov failed with the following error: ${error.message}`
);
}
});
} catch (error) {
if (fail_ci) {

4
jest.config.js Normal file
View File

@@ -0,0 +1,4 @@
module.exports = {
preset: 'ts-jest',
testEnvironment: 'node',
}

4901
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,10 +1,13 @@
{
"name": "codecov-action",
"version": "1.0.5",
"version": "1.0.13",
"description": "Upload coverage reports to Codecov from GitHub Actions",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"test": "jest --coverage",
"test-calculator": "jest --testPathPattern=src/calculator/ --coverage --coverageDirectory=coverage/calculator",
"test-index": "jest --testPathPattern=src/index --coverage --coverageDirectory=coverage/index",
"test-all": "yarn run test && yarn run test-calculator && yarn run test-index",
"build": "ncc build index.js"
},
"repository": {
@@ -12,8 +15,8 @@
"url": "git+https://github.com/codecov/codecov-action.git"
},
"keywords": [],
"author": "",
"license": "ISC",
"author": "Ibrahim Ali",
"license": "MIT",
"bugs": {
"url": "https://github.com/codecov/codecov-action/issues"
},
@@ -21,8 +24,16 @@
"dependencies": {
"@actions/core": "^1.2.0",
"@actions/exec": "^1.0.1",
"@zeit/ncc": "^0.20.5",
"@types/jest": "^26.0.4",
"@zeit/ncc": "^0.22.3",
"fs": "0.0.1-security",
"request": "^2.88.0"
}
"jest": "^26.1.0",
"jest-junit": "^10.0.0",
"request": "^2.88.0",
"requestretry": "^4.1.1",
"ts-jest": "^26.1.1",
"typescript": "^3.9.6",
"yarn": "^1.22.4"
},
"devDependencies": {}
}

View File

@@ -0,0 +1,11 @@
import Calculator from './calculator'
test('adds 2 + 3 to equal 5', () => {
const calc = new Calculator()
expect(calc.add(2, 3)).toBe(5);
});
test('subtracts 2 - 3 to equal -1', () => {
const calc = new Calculator()
expect(calc.subtract(2, 3)).toBe(-1);
});

View File

@@ -0,0 +1,10 @@
export default class Calculator {
add(x : number, y : number) : number {
return x + y;
}
subtract(x: number, y: number) : number {
return x - y;
}
}

11
src/index/index.test.ts Normal file
View File

@@ -0,0 +1,11 @@
import Index from "./index";
test('test uncovered if', () => {
const indexObj = new Index();
expect(indexObj.uncovered_if()).toEqual(false);
});
test('fully covered', () => {
const indexObj = new Index();
expect(indexObj.fully_covered()).toEqual(true);
});

21
src/index/index.ts Normal file
View File

@@ -0,0 +1,21 @@
export default class Index {
//This function is tested and part of it is uncovered
uncovered_if = (a = true) => {
if (a == true) {
return false
} else {
return true
}
}
//This function will be fully covered
fully_covered = () => {
return true
}
//This function will not be tested by unit tests
uncovered = () => {
return true
}
}