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.

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

fix: bump to v5 and update README #1655

Merged
merged 4 commits into from
Nov 19, 2024
Merged

Conversation

thomasrockhu-codecov
Copy link
Contributor

@thomasrockhu-codecov thomasrockhu-codecov commented Nov 15, 2024

fixes #1652

README.md Outdated Show resolved Hide resolved
| `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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you ever documented exactly what you mean here? Because I don't know.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
| `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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason we still offer this?

thomasrockhu-codecov and others added 2 commits November 15, 2024 08:38
Co-authored-by: Joe Becher <joe.becher@sentry.io>
@thomasrockhu-codecov thomasrockhu-codecov merged commit fb6775d into main Nov 19, 2024
13 checks passed
@thomasrockhu-codecov thomasrockhu-codecov deleted the th/fix-update-README branch November 19, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README.md examples still use v4
2 participants