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

jf git count-contributors required parameters information is incorrect #161

Closed
tomjfrog opened this issue Aug 30, 2024 · 1 comment
Closed
Labels
bug Something isn't working

Comments

@tomjfrog
Copy link

Describe the bug

In the help content for the JF CLI command jf git cc, the --scm-type command is listed as [Optional], but it is required when you run the command.

See below

> jf --version
jf version 2.65.0

> jf git cc --help

Name:
  jf git count-contributors - List all GIT providers' contributing developers.

Usage:
  jf git count-contributors [command options]

Options:
  --detailed-summary    [Default: false] Set to true to get a contributors detailed summary.
  --input-file          [Optional] Path to an input file in YAML format contains multiple git providers. With this option, all other scm flags will be ignored and only git servers mentioned in the file will be examined..
  --months              [Default: 1] Number of months to analyze.
  --owner               [Optional] The format of the owner key depends on the Git provider: On GitHub and GitLab, the owner is typically an individual or an organization, On Bitbucket, the owner can also be a project. In the case of a private instance on Bitbucket, the individual or organization name should be prefixed with '~'.
  --repo-name           [Optional] List of semicolon-separated(;) repositories names to analyze, If not provided all repositories related to the provided owner will be analyzed.
  --scm-api-url         [Optional] SCM API URL. For example: 'https://api.github.com'.
  --scm-type            [Optional] SCM type. Possible values are: gitlab, github and bitbucket.
  --token               [Optional] SCM API token. In the absence of a flag, tokens should be passed in the JF_GIT_TOKEN enviroment variable, or in the corresponding environment variables 'JFROG_CLI_GITLAB_TOKEN, JFROG_CLI_GITHUB_TOKEN or JFROG_CLI_BITBUCKET_TOKEN'.


> jf git cc --owner tomjfrog --months 12 --detailed-summary true
10:57:36 [🔵Info] Trace ID for JFrog Platform logs: 42bc1e3d7b541e98
10:57:36 [🚨Error] The --scm-type option is mandatory

Current behavior

--scm-type is noted as optional.

Reproduction steps

Run the command jf git cc without the --scm-type parameter and it will fail.

Expected behavior

The information in the help content to reference the parameter as required.

JFrog CLI-Security version

2.65

JFrog CLI version (if applicable)

2.65

Operating system type and version

macOS 14.6.1 23G93 x86_64

JFrog Xray version

N/A

@tomjfrog tomjfrog added the bug Something isn't working label Aug 30, 2024
@attiasas
Copy link
Contributor

Hi @tomjfrog, thank you for reporting this issue.
You can follow the fix here: #170, It should be available soon
If you have any more questions or issues in this matter you can reopen this.
Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants