GitHub - 예시

옵션 목록 및 몇 가지 예시

사용 가능한 옵션:

  --version                 버전 번호 표시                         [부울]
  --help                    도움말 표시                                  [부울]
  --token                   GitHub 토큰                               [필수]
  --orgs                    [선택 사항] 기여자를 계산할 GitHub 조직 목록 (쉼표로 구분)
                            리포지토리
  --repo                    [선택 사항] 기여자 수를 계산할 특정 리포지토리
  --exclusionFilePath       [선택 사항] 제외 목록 파일 경로
  --json                    [선택 사항] JSON 출력, "consolidateResults" 명령 사용 시 필수

명령 실행 전

이 가이드를 사용하여 GitHub 토큰을 가져오거나 새 토큰을 생성하십시오.

참고: 토큰에 리포지토리 읽기 권한이 있는지 확인하십시오.

명령 실행

다음 사용 수준 및 옵션을 고려하십시오.

사용 수준

• GitHub의 모든 조직의 모든 리포지토리에 대한 커밋을 가져오려면 GitHub 토큰을 제공하십시오.

  snyk-scm-contributors-count github --token TOKEN

• GitHub의 일부 조직 및 해당 리포지토리에 대한 커밋을 가져오려면 GitHub 토큰 및 쉼표로 구분된 조직 이름을 제공하십시오.

  snyk-scm-contributors-count github --token TOKEN --orgs ORG_ONE,ORG_TWO,ORG_THREE

• GitHub의 단일 리포지토리에 대한 커밋만 가져오려면 GitHub 토큰, 조직 이름 및 리포지토리 이름을 제공하십시오.

  snyk-scm-contributors-count github --token TOKEN --orgs ORG --repo REPO

옵션

• 일부 기여자가 커밋에 계산되는 것을 제외하려면 무시할 이메일(새 줄로 구분)이 포함된 제외 파일을 추가하고 해당 파일 경로와 함께 --exclusionFilePath를 적용하십시오.

snyk-scm-contributors-count github --token TOKEN --orgs ORG_ONE,ORG_TWO --exclusionFilePath PATH_TO_FILE

• 출력을 json 형식으로 설정하려면 --json 플래그를 추가하십시오.

  snyk-scm-contributors-count github --token TOKEN --json

• 자세한 출력(verbose output)을 위해 디버그 모드로 실행하려면 DEBUG=snyk*를 접두사로 추가하십시오.

DEBUG=snyk* snyk-scm-contributors-count github --token TOKEN --orgs ORG --repo REPO --exclusionFilePath PATH_TO_FILE --json