codecov-cli 0.1.4

Codecov Command Line Interface

CodecovCLI

CodecovCLI is a new way for users to interact with Codecov directly from the user’s terminal or CI platform. Many Codecov features that require the user’s interference can be done via the codecovCLI. It saves commits, creates reports, uploads coverage and has many more amazing features.

• Installing
• Usage
• Codecov-cli Commands
  • create-commit
  • create-report
  • do-upload
  • create-report-results
  • get-report-results
  • pr-base-picking
• How to upload to Codecov
• How to Local upload
• Plugin System
• Contributions
  • Requirements
  • Guidelines
• Releases

Installing

To use codecov-cli in your local machine, or your CI workflows, you need to install it

pip install codecov-cli

The above command will download the latest version of Codecov-cli. If you wish to use a specific version, releases can be viewed here. You can also find Codecovcli here or in the Github releases where you can download the binary distributable files.

Usage

If the installation is successful, running codecovcli --help will output the available commands along with the different general options that can be used with them.

Usage: codecovcli [OPTIONS] COMMAND [ARGS]...

Codecov-cli supports inputs from the user. These inputs, along with their descriptions and usage contexts, are listed in the table below:

Input	Description	Usage
--auto-load-params-from	The CI/CD platform	Optional
--codecov-yml-path	The path for your codecov.yml	Optional
--enterprise-url	Change the upload host (Enterprise use)	Optional
--version	Codecov-cli's version	Optional
--verbose or -v	Run the cli with verbose logging	Optional

Codecov-cli Commands

Command	Description
create-commit	Saves the commit's metadata in codecov, only need to do it once for a commit
create-report	Creates an empty report in codecov with initial data e.g. report name, report's commit
do-upload	Searches for and uploads coverage data to codecov
create-report-results	Used for local upload. It tells codecov that you finished local uploading and want it to calculate the results for you to get them locally.
get-report-results	Used for local upload. It asks codecov to provide you the report results you calculated with the previous command.
pr-base-picking	Tells codecov that you want to explicitly define a base for your PR

Note: Every command has its own different options that will be mentioned later in this doc. Codecov will try to load these options from your CI environment variables, if not, it will try to load them from git, if not found, you may need to add them manually.

create-commit

codecovcli create-commit [Options]

Option	Description	Usage
-C, --sha, --commit-sha	Commit SHA (with 40 chars)	Required
--parent-sha	SHA (with 40 chars) of what should be the parent of this commit	Optional
-P, --pr, --pull-request-number	Specify the pull request number manually. Used to override pre-existing CI environment variables	Optional
-B, --branch	Branch to which this commit belongs to	Optional
-r, --slug	owner/repo slug used instead of the private repo token in Self-hosted	Required
-t, --token	Codecov upload token	Required
--git-service	Git Provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server	Required
--help	Shows usage, and command options

create-report

codecovcli create-report [OPTIONS]

Option	Description	Usage
-C, --sha, --commit-sha	Commit SHA (with 40 chars)	Required
-r, --slug	owner/repo slug used instead of the private repo token in Self-hosted	Required
-t, --token	Codecov upload token	Required
--git-service	Git Provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server	Required
--code	The code of the report. This is used in local uploading to isolate local reports from regular or cloud reports uploaded to codecov so they don't get merged. It's basically a name you give to your report e.g. local-report.	Optional
--help	Shows usage, and command options

do-upload

codecovcli do-upload [OPTIONS]

Option	Description	Usage
-C, --sha, --commit-sha	Commit SHA (with 40 chars)	Required
--report-code	The code of the report defined when creating the report. If unsure, leave default	Optional
--network-root-folder	Root folder from which to consider paths on the network section default: (Current working directory)	Optional
-s, --dir, --coverage-files-search-root-folder	Folder where to search for coverage files default: (Current Working Directory)	Optional
--exclude, --coverage-files-search-exclude-folder	Folders to exclude from search	Optional
-f, --file, --coverage-files-search-direct-file	Explicit files to upload	Optional
-b, --build, --build-code	Specify the build number manually	Optional
--build-url	The URL of the build where this is running	Optional
--job-code	The job code for the CI run	Optional
-t, --token	Codecov upload token	Required
-n, --name	Custom defined name of the upload. Visible in Codecov UI	Optional
-B, --branch	Branch to which this commit belongs to	Optional
-r, --slug	owner/repo slug	Required
-P, --pr, --pull-request-number	Specify the pull request number manually. Used to override pre-existing CI environment variables	Optional
-e, --env, --env-var	Specify environment variables to be included with this build.	Optional
-F, --flag	Flag the upload to group coverage metrics. Multiple flags allowed.	Optional
--plugin	plugins to run. Options: xcode, gcov, pycoverage. The default behavior runs them all.	Optional
-Z, --fail-on-error	Exit with non-zero code in case of error uploading.	Optional
-d, --dry-run	Don't upload files to Codecov	Optional
--legacy, --use-legacy-uploader	Use the legacy upload endpoint	Optional
--git-service	Git Provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server	Required
--help	Shows usage, and command options

create-report-results

codecovcli create-report-results [OPTIONS]

Option	Description	Usage
--commit-sha	Commit SHA (with 40 chars)	Required
--code	The code of the report. If unsure, leave default	Required
--slug	owner/repo slug	Required
--git-service	Git provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server	Optional
-t, --token	Codecov upload token	Required
--help	Shows usage, and command options

get-report-results

codecovcli get-report-results [OPTIONS]

Option	Description	Usage
--commit-sha	Commit SHA (with 40 chars)	Required
--code	The code of the report. If unsure, leave default	Required
--slug	owner/repo slug	Required
--git-service	Git provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server	Optional
-t, --token	Codecov upload token	Required
--help	Shows usage, and command options

pr-base-picking

codecovcli pr-base-picking [OPTIONS]

Option	Description	Usage
--base-sha	Base commit SHA (with 40 chars)	Required
--pr	Pull Request id to associate commit with	Required
--slug	owner/repo slug	Required
-t, --token	Codecov upload token	Required
--service	Git provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server	Optional
--help	Shows usage, and command options

How to upload to Codecov

In your CI workflow, you need to add these commands:

pip install codecovcli
codecovcli create-commit
codecovcli create-report
codecovcli do-upload

You can customize the commands with the options aligned with each command.

How to Local upload:

If you CI workflow takes too much time to run, and you have to wait for it to finish to know the coverage results, you can make your changes locally, make a PR and then run these commands:

pip install codecovcli
codecovcli create-commit
codecovcli create-report --code <CODE>
codecovcli do-upload --report-code <CODE>
codecovcli create-report-results --code <CODE>
codecovcli get-report-results --code <CODE>

Codecov will calculate the coverage results, and return them in your terminal, telling you whether your PR will fail or pass the coverage check.

Plugin System

In some of the commands, there is a plugin system. For most cases, one might find that changing them is not really needed. But in some cases, have some custom logic run would be beneficial

WIP

Contributions

Requirements

To start, most of this package is a normal Python package. The main different thing is the static analysis tool that uses both git submodules and c code

Before installing, one should pull the submodules with

git submodule update --init

Then, install dependencies with

pip install -r requirements.txt 
python setup.py develop

The c code shouldn't require anything in most places, but it might ask you to install compilers and stuff. Most of the times you can find the instructions online given the error message

Guidelines

There are a few guidelines when developing in this systems. We have a few notable folders:

1. commands - It's the folder that interacts with the caller. This is where the commands themselves should live. They are not meant to do heavy lifting. They only do wiring, which is mostly parsing the input parameters
2. services - It's where the heavy logic lives. It's mostly organizaed by which command needs them.
3. helpers - This is meant for logic that is probably useful accross different commands. For example, logging helpers, or the logic the searches folders

Releases

The standard way to making a new release is the following:

1. Open a PR that increases the version number in setup.py. As a rule of thumb, just add one to the micro version (number most to the right).

2. Get the up-to-date master branch locally and run the tag.release command from the Makefile.

$ make tag.release version=v<VERSION_NUM>

The version tag must match the regex defined on the Makefile (tag_regex := ^v([0-9]{1,}\.){2}[0-9]{1,}([-_]\w+)?$).

Note:
Releases with test word in them are created as draft.
Releases with beta work in them are created as pre-release.