snyk / user-docs

Gitbook documentation repo.
https://docs.snyk.io/
23 stars 188 forks source link

SCM Contributor Count CLI - GitLab - Clarify behaviour when having the same group names, #206

Closed beanaroo closed 1 year ago

beanaroo commented 1 year ago

The current documentation states:

Note that for nested groups, you need to provide the lowest level group name, for example, for TopLevelGroup/MidLevelGroup/LowLevelGroup provide only "LowLevelGroup" with the --groups flag

What happens when you have multiple groups with the same "LowLevelGroup" names?

acme-inc
 ├── product-a
 │   ├── backends
 │   ├── frontends
 │   └── libraries
 └── product-b
     ├── backends
     ├── frontends
     └── libraries

In this example, I only want to specify the backends group for product-a as well as both libraries groups.

The documentation could be a bit more clear on how the group selection works.

awileysnyk commented 1 year ago

To help in finding an answer for this question: https://docs.snyk.io/snyk-api-info/other-tools/snyk-scm-contributors-count-cli-tool/the-scripts/gitlab-and-gitlab-server/gitlab-examples#usage-levels is the URL of the doc that has the text in question. The docs team will investigate.

awileysnyk commented 1 year ago

Closing this issue. Snyk is considering it.