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

create-commit documentation does not claim to support -Z #435

Open
jsoref opened this issue May 7, 2024 · 1 comment
Open

create-commit documentation does not claim to support -Z #435

jsoref opened this issue May 7, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jsoref
Copy link

jsoref commented May 7, 2024

https://github.com/codecov/codecov-cli/blob/main/README.md#create-commit

codecov-cli/README.md

Lines 132 to 144 in 88b7c71

## 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
|-h, --help | Shows usage, and command options

However, the sibling repository passes it:
https://github.com/codecov/codecov-action/blob/f691d469fbba7b31a1cb026e3a2f86e28c9dcdb6/src/buildExec.ts#L87
https://github.com/codecov/codecov-action/blob/f691d469fbba7b31a1cb026e3a2f86e28c9dcdb6/src/buildExec.ts#L130-L131

@thomasrockhu-codecov thomasrockhu-codecov added the documentation Improvements or additions to documentation label May 7, 2024
@thomasrockhu-codecov thomasrockhu-codecov self-assigned this Nov 7, 2024
@thomasrockhu-codecov
Copy link
Contributor

Thanks @jsoref, I'll update the docs. The ones in the Action are more accurate

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants