Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: update HELPFILE #1037

Merged
merged 7 commits into from
May 4, 2023
Merged

chore: update HELPFILE #1037

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a20e057
chore: update HELPFILE
kleisauke Apr 30, 2023
fe3cd48
Update HELPFILE
thomasrockhu-codecov May 2, 2023
43d5708
Update HELPFILE
thomasrockhu-codecov May 2, 2023
dd9851a
Merge branch 'main' into update-helpfile
thomasrockhu-codecov May 2, 2023
f2dbcf7
Merge branch 'main' into update-helpfile
thomasrockhu-codecov May 2, 2023
2f17674
Merge branch 'main' into update-helpfile
thomasrockhu-codecov May 3, 2023
25b13d4
Merge branch 'main' into update-helpfile
thomasrockhu-codecov May 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
123 changes: 80 additions & 43 deletions HELPFILE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,81 @@
Usage: codecov <command> [options]

Options:
-b, --build Specify the build number manually
-B, --branch Specify the branch manually
-e, --env Specify environment variables to be included with this build.
Also accepting environment variables: CODECOV_ENV=VAR,VAR2
-C, --sha Specify the commit SHA manually
-f, --file Target file(s) to upload
-F, --flags Flag the upload to group coverage metrics [default: ""]
-n, --name Custom defined name of the upload. Visible in Codecov UI
[default: ""]
-N, --parent The commit SHA of the parent for which you are uploading
coverage. If not present, the parent will be determined using
the API of your repository provider. When using the repository
provider's API, the parent is determined via finding the
closest ancestor to the commit.
-P, --pr Specify the pull request number manually
-s, --dir Directory to search for coverage reports.
Already searches project root and current working directory
-t, --token Codecov upload token [default: ""]
-T, --tag Specify the git tag [default: ""]
-v, --verbose Run with verbose logging [boolean]
-R, --rootDir Specify the project root directory when not in a git repo
-Z, --nonZero Should errors exit with a non-zero (default: false)
[boolean] [default: false]
-d, --dryRun Don't upload files to Codecov [boolean]
-r, --slug Specify the slug manually
-u, --url Change the upload host (Enterprise use)
[string] [default: "https://codecov.io"]
-c, --clean Move discovered coverage reports to the trash
[boolean] [default: false]
-X, --feature Toggle functionalities.
Separate multiple ones by comma: -X network,search
-X network Disable uploading the file network
-X search Disable searching for coverage files
[string]
-Q, --source Used internally by Codecov, this argument helps track wrappers
of the uploader (e.g. GitHub Action, CircleCI Orb)
[string] [default: ""]
--gcov Run with gcov support [boolean] [default: false]
--gcovIgnore Paths to ignore during gcov gathering [string]
--gcovInclude Paths to include during gcov gathering [string]
--gcovArgs Extra arguments to pass to gcov [string]
--version Show version number [boolean]
-h, --help Show help [boolean]
-B, --branch Specify the branch manually [string]
-b, --build Specify the build number manually [number]
-c, --clean Move discovered coverage reports to the trash
[boolean] [default: false]
-C, --sha Specify the commit SHA manually [string]
--changelog, --CL Display a link for the current changelog
[boolean] [default: false]
-d, --dryRun Don't upload files to Codecov
[boolean] [default: false]
-e, --env Specify environment variables to be included
with this build.
Also accepting environment variables:
CODECOV_ENV=VAR,VAR2
-f, --file Target file(s) to upload [string]
--fullReport, --full Specify the path to a previously uploaded
Codecov report [string]
-F, --flags Flag the upload to group coverage metrics
[string] [default: ""]
-g, --gcov Run with gcov support [boolean] [default: false]
--gcovArgs, --ga Extra arguments to pass to gcov [string]
--gcovIgnore, --gi Paths to ignore during gcov gathering [string]
--gcovInclude, --gI Paths to include during gcov gathering [string]
--gcovExecutable, --gx gcov executable to run. Defaults to 'gcov'
[string]
-i, --networkFilter Specify a filter on the files listed in the
network section of the Codecov report. Useful
for upload-specific path fixing [string]
-k, --networkPrefix Specify a prefix on files listed in the network
section of the Codecov report. Useful to help
resolve path fixing [string]
-n, --name Custom defined name of the upload. Visible in
Codecov UI [string] [default: ""]
-N, --parent The commit SHA of the parent for which you are
uploading coverage. If not present, the parent
will be determined using the API of your
repository provider. When using the repository
provider's API, the parent is determined via
finding the closest ancestor to the commit.
[string]
-P, --pr Specify the pull request number manually[number]
-Q, --source Used internally by Codecov, this argument helps
track
wrappers of the uploader (e.g. GitHub Action,
CircleCI Orb) [string] [default: ""]
-R, --rootDir Specify the project root directory when not in a
git repo
-r, --slug Specify the slug manually [string] [default: ""]
-s, --dir Directory to search for coverage reports.
Already searches project root and current
working directory [string]
-T, --tag Specify the git tag [string] [default: ""]
-t, --token Codecov upload token [string] [default: ""]
-U, --upstream The upstream http proxy server to connect
through [string] [default: ""]
-u, --url Change the upload host (Enterprise use)
[string] [default: "https://codecov.io"]
-v, --verbose Run with verbose logging [boolean]
-X, --feature Toggle functionalities. Separate multiple ones
by comma: -X network,search
-X fixes Enable file fixes to ignore
common lines from coverage (e.g. blank lines or
empty brackets)
-X network Disable uploading the file
network
-X search Disable searching for coverage
files [string]
--xcode, --xc, --xc Deprecating, please use xs] Run with xcode
support [boolean] [default: false]
--xcodeArchivePath, --xp [Deprecating, please use xs] Specify the xcode
archive path. Likely specified as the
-resultBundlePath and should end in .xcresult
[string]
--swift, --xs Run with swift support[boolean] [default: false]
--swiftProject, --xsp Specify the swift project [string] [default: ""]
-Z, --nonZero Should errors exit with a non-zero (default:
false) [boolean] [default: false]
--version Show version number [boolean]
-h, --help Show help [boolean]