fix: bump to v5 and update README #1655
Open
+47
−35
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drazisil-codecov
approved these changes
Nov 15, 2024
| | `directory` | Folder to search for coverage files. Default to the current working directory | Optional | ||
| | `disable_file_fixes` | Disable file fixes to ignore common lines from coverage (e.g. blank lines or empty brackets). Read more here https://docs.codecov.com/docs/fixing-reports | Optional | ||
| | `disable_search` | Disable search for coverage files. This is helpful when specifying what files you want to upload with the files option. | Optional | ||
| | `disable_safe_directory` | Disable setting safe directory. Set to true to disable. | Optional |
There was a problem hiding this comment.
Have you ever documented exactly what you mean here? Because I don't know.
| | `override_build` | Specify the build number | Optional | ||
| | `exclude` | Comma-separated list of folders to exclude from search. | Optional | ||
| | `fail_ci_if_error` | On error, exit with non-zero code | Optional | ||
| | `files` | Comma-separated list of explicit files to upload. These will be added to the coverage files found for upload. If you wish to only upload the specified files, please consider using disable-search to disable uploading other files. | Op |
There was a problem hiding this comment.
Maybe explicit list? Otherwise I'm concerned about the type of files being uploaded to us ;)
| | `report_type` | The type of file to upload, coverage by default. Possible values are "testing", "coverage". | Optional | ||
| | `root_dir` | Root folder from which to consider paths on the network section. Defaults to current working directory. | Optional | ||
| | `skip_validation` | Skip integrity checking of the CLI. This is NOT recommended. | Optional | ||
| | `slug` | [Required when using the org token] Set to the owner/repo slug used instead of the private repo token. Only applicable to some Enterprise users. | Optional |
There was a problem hiding this comment.
This is for all org token users, not just some Enterprise ones. Correct?
| | `swift_project` | Specify the swift project name. Useful for optimization. | Optional | ||
| | `token` | Repository Codecov token. Used to authorize report uploads | Optional | ||
| | `url` | Set to the Codecov instance URl. Used by Dedicated Enterprise Cloud customers. | Optional | ||
| | `use_legacy_upload_endpoint` | Use the legacy upload endpoint. | Optional |
There was a problem hiding this comment.
Is there a reason we still offer this?
Co-authored-by: Joe Becher <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #1652