Skip to content

Commit

Permalink
Merge pull request #137 from codecov/dana/read-me
Browse files Browse the repository at this point in the history 
Update README.md
  • Loading branch information
@dana-yaish
dana-yaish authored May 2, 2023
2 parents 62abfb1 + d7d7aa6 commit a723c4c
Showing 1 changed file with 172 additions and 33 deletions.
205 changes: 172 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,57 +1,187 @@
# CodecovCLI

[![codecov](https://codecov.io/gh/codecov/codecov-cli/branch/master/graph/badge.svg?token=jN0CICuA6Z)](https://codecov.io/gh/codecov/codecov-cli)

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](#installing)
- [Running the upload command](#running-the-upload-command)
- [Running other commands](#running-other-commands)
- [Usage](#usage)
- [Codecov-cli Commands](#codecov-cli-commands)
- [create-commit](#create-commit)
- [create-report](#create-report)
- [do-upload](#do-upload)
- [create-report-results](#create-report-results)
- [get-report-results](#get-report-results)
- [pr-base-picking](#pr-base-picking)
- [How to upload to Codecov](#how-to-upload-to-codecov)
- [How to Local upload](#how-to-local-upload)
- [Plugin System](#plugin-system)
- [Development](#development)
- [Contributions](#contributions)
- [Requirements](#requirements)
- [Guidelines](#guidelines)
- [Releases](#releases)

# Installing

To install this package locally, you can run
To use codecov-cli in your local machine, or your CI workflows, you need to install it

`python setup.py develop`
`pip install codecov-cli`

If you are installing from somewhere else, you can add:
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](https://cli.codecov.io/) or in the [Github releases](https://github.com/codecov/codecov-cli/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.
```
codecov-cli @ git+ssh://[email protected]/codecov/codecov-cli.git@commitsha
Usage: codecovcli [OPTIONS] COMMAND [ARGS]...
```

to its requirements file

# Running the upload command

To run the CLI, do:

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:
```
codecovcli --auto-load-params-from circleci do-upload
pip install codecovcli
codecovcli create-commit
codecovcli create-report
codecovcli do-upload
```
You can customize the commands with the options aligned with each command.

and pass parameters as you see fit. You can get help on

# 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:
```
codecovcli --help
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>
```

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

```
codecovcli do-upload --help
```

# Running other commands

There are many nested commands here.

# 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

# Development
# Contributions

## Requirements

Expand All @@ -62,8 +192,13 @@ 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 on 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 messsage
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

Expand All @@ -75,11 +210,15 @@ There are a few guidelines when developing in this systems. We have a few notabl

# Releases

The standard way to making a new release is to get the up-to-date master branch locally and run the `tag.release` command from the Makefile.
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).

`$ make tag.release version=v0.1.1`
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+)?$`).
Also keep in mind:
* Releases with `test` word in them are created as `draft`
* Releases with `beta` work in them are created as `pre-release`

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

0 comments on commit a723c4c

Please sign in to comment.