actions/codecov-action
1
0
Fork 0
mirror of https://github.com/codecov/codecov-action.git synced 2025-12-23 20:27:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #53 from armano2/branch-support

Browse Source 
Add support for pull requests and tokenless uploads
This commit is contained in:
Ibrahim Ali
2020-03-04 22:24:12 -08:00
committed by GitHub
parent 66879ff350 d9faadf52a
commit d7c91c57ee
8 changed files with 24042 additions and 24092 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
.github/workflows/main.yml vendored
View File

@@ -1,23 +1,15 @@
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
file: ./sample-coverage/coverage.xml

27
README.md
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 macOS + Windows builds and tokenless uploads for public repos!
## 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,26 +18,26 @@ 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
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). 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` paramter 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
| `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
### Example `workflow.yml` with Codecov Action
@@ -67,7 +69,6 @@ jobs:
file: ./coverage.xml
flags: unittests
name: codecov-umbrella
yml: ./codecov.yml
fail_ci_if_error: true
```
## Contributing

7
action.yml
View File

@@ -6,17 +6,14 @@ inputs:
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
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'
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

47872
dist/index.js vendored
View File

File diff suppressed because one or more lines are too long

130
index.js
View File

@@ -9,7 +9,6 @@ try {
const token = core.getInput("token");
const flags = core.getInput("flags");
const file = core.getInput("file");
const yml = core.getInput("yml");
fail_ci = core.getInput("fail_ci_if_error").toLowerCase();
if (
@@ -51,105 +50,50 @@ try {
};
options.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 (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();
});
}
if(token){
options.env.CODECOV_TOKEN = token
}
const execArgs = ["codecov.sh"];
if (file) {
execArgs.push(
"-f", `${file}`
);
}
execArgs.push(
"-n", `${name}`,
"-F", `${flags}`
);
if (fail_ci) {
execArgs.push(
"-Z"
);
}
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) {

4
package-lock.json generated
View File

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

7
package.json
View File

@@ -12,8 +12,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"
},
@@ -24,5 +24,6 @@
"@zeit/ncc": "^0.20.5",
"fs": "0.0.1-security",
"request": "^2.88.0"
}
},
"devDependencies": {}
}

71
sample-coverage/coverage.xml Normal file
View File

@@ -0,0 +1,71 @@
<?xml version="1.0" ?>
<coverage branch-rate="0" branches-covered="0" branches-valid="0" complexity="0" line-rate="0.3243" lines-covered="12" lines-valid="37" timestamp="1564551215562" version="4.5.4">
<!-- Generated by coverage.py: https://coverage.readthedocs.io -->
<!-- Based on https://raw.githubusercontent.com/cobertura/web/master/htdocs/xml/coverage-04.dtd -->
<sources>
<source>/app</source>
</sources>
<packages>
<package branch-rate="0" complexity="0" line-rate="0.3243" name=".">
<classes>
<class branch-rate="0" complexity="0" filename="index.py" line-rate="0.75" name="index.py">
<methods/>
<lines>
<line hits="1" number="1"/>
<line hits="1" number="2"/>
<line hits="1" number="3"/>
<line hits="0" number="5"/>
<line hits="1" number="7"/>
<line hits="1" number="8"/>
<line hits="1" number="10"/>
<line hits="0" number="11"/>
</lines>
</class>
<class branch-rate="0" complexity="0" filename="request.py" line-rate="0" name="request.py">
<methods/>
<lines>
<line hits="0" number="3"/>
<line hits="0" number="4"/>
<line hits="0" number="5"/>
<line hits="0" number="7"/>
<line hits="0" number="9"/>
<line hits="0" number="11"/>
<line hits="0" number="14"/>
<line hits="0" number="16"/>
<line hits="0" number="18"/>
<line hits="0" number="19"/>
<line hits="0" number="20"/>
<line hits="0" number="22"/>
<line hits="0" number="24"/>
<line hits="0" number="25"/>
<line hits="0" number="26"/>
<line hits="0" number="28"/>
<line hits="0" number="29"/>
</lines>
</class>
<class branch-rate="0" complexity="0" filename="test_index.py" line-rate="1" name="test_index.py">
<methods/>
<lines>
<line hits="1" number="1"/>
<line hits="1" number="2"/>
<line hits="1" number="4"/>
<line hits="1" number="5"/>
<line hits="1" number="7"/>
<line hits="1" number="8"/>
</lines>
</class>
<class branch-rate="0" complexity="0" filename="text_index.py" line-rate="0" name="text_index.py">
<methods/>
<lines>
<line hits="0" number="1"/>
<line hits="0" number="2"/>
<line hits="0" number="4"/>
<line hits="0" number="5"/>
<line hits="0" number="7"/>
<line hits="0" number="8"/>
</lines>
</class>
</classes>
</package>
</packages>
</coverage>