Skip to content
This repository was archived by the owner on Jul 16, 2025. It is now read-only.

Commit 145701f

Browse files
docs: add empty-upload cmd section (#349)
1 parent ab1c326 commit 145701f

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,16 @@ CodecovCLI is a new way for users to interact with Codecov directly from the use
2020
- [create-report-results](#create-report-results)
2121
- [get-report-results](#get-report-results)
2222
- [pr-base-picking](#pr-base-picking)
23+
- [send-notifications](#send-notifications)
24+
- [empty-upload](#empty-upload)
2325
- [How to Use Local Upload](#how-to-use-local-upload)
2426
- [Work in Progress Features](#work-in-progress-features)
2527
- [Plugin System](#plugin-system)
2628
- [Static Analysis](#static-analysis)
2729
- [Contributions](#contributions)
2830
- [Requirements](#requirements)
2931
- [Guidelines](#guidelines)
32+
- [Dependencies](#dependencies)
3033
- [Releases](#releases)
3134

3235
# Installing
@@ -229,6 +232,23 @@ Codecov-cli supports user input. These inputs, along with their descriptions and
229232
| --git-service | Git provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server | Optional
230233
| -h,--help |Show this message and exit.
231234

235+
## empty-upload
236+
237+
Used if the changes made don't need testing, but PRs require a passing codecov status to be merged.
238+
This command will scan the files in the commit and send passing status checks configured if all the changed files
239+
are ignored by codecov (including README and configuration files)
240+
241+
`Usage: codecovcli empty-upload [OPTIONS]`
242+
243+
Options:
244+
-C, --sha, --commit-sha TEXT Commit SHA (with 40 chars) [required]
245+
-Z, --fail-on-error Exit with non-zero code in case of error
246+
--git-service [github|gitlab|bitbucket|github_enterprise|gitlab_enterprise|bitbucket_server]
247+
-t, --token TEXT Codecov upload token
248+
-r, --slug TEXT owner/repo slug used instead of the private
249+
repo token in Self-hosted
250+
-h, --help Show this message and exit.
251+
232252
# How to Use Local Upload
233253

234254
The CLI also supports "dry run" local uploading. This is useful if you prefer to see Codecov status checks and coverage reporting locally, in your terminal, as opposed to opening a PR and waiting for your full CI to run. Local uploads do not interfere with regular uploads made from your CI for any given commit / Pull Request.

0 commit comments

Comments
 (0)