Skip to content

Latest commit

 

History

History
75 lines (65 loc) · 4.03 KB

github-enterprise-example.md

File metadata and controls

75 lines (65 loc) · 4.03 KB

Github Enterprise

Available options:

  --version                 Show version number                        [boolean]
  --help                    Show help                                  [boolean]
  --token                   Github Enterprise token                    [required]
  --url                     Your Github host custom URL.
                            e.g https://ghe.prod.company.org/          [required]
  --orgs                    [Optional] A list of Github Enterprise organizations, separeted by comma, 
                            to fetch and count contributors for their repositories              
  --repo                    [Optional] Specific repo to count only for
  --fetchAllOrgs            [Optional] When enabled, will fetch all orgs that the token has access to
                            rather than fetching only the orgs your authorized to operate in.
  --exclusionFilePath       [Optional] Exclusion list filepath
  --json                    [Optional] JSON output
  --skipSnykMonitoredRepos  [Optional] Skip Snyk monitored repos and count contributors for all repos

Before running the command:

  1. Export SNYK_TOKEN (if you want to get the contributors ONLY for repos that are already monitored by Snyk) =>
    • Go to Snyk-account and create a token if not already exists.
    • Copy the token value
    • Export the token in your enviroment:
    export SNYK_TOKEN=<YOUR-SNYK-TOKEN>
  2. Get your Github Enterprose token or create a new one with this guide =>
    • Make sure that your token has access to the repos that you want to get the contributors count for

Running the command

Consider the following levels of usage and options:

Usage levels:

  • I want to get commits for all repos in all my orgs in Github Enterprise => Only provide the Github Enterprise token:
snyk-scm-contributors-count github-enterprise --token TOKEN --url HOST_URL
  • I want to get commits for some orgs and their repos in Github Enterprise => Provide the Github Enterprise token and the org names, seperated by a comma:
snyk-scm-contributors-count github-enterprise --token TOKEN --url HOST_URL --orgs ORG_ONE,ORG_TWO,ORG_THREE
  • I want to get commits for only one repo in Github Enterprise => Provide the Github Enterprise token, one org name and one repo name:
snyk-scm-contributors-count github-enterprise --token TOKEN --url HOST_URL --orgs ORG --repo REPO

Options:

  • I want to get all the commits from Github Enterprise regardless of the repos that are already monitored by Snyk (You might have repo in Github Enterprise that are not monitored in Snyk, using this flag will skip checking for Snyk monitored repos and will go directly to Github Enterprise to fetch tha commits) => add the --skipSnykMonitoredRepos flag to the command:
snyk-scm-contributors-count github-enterprise --token TOKEN --url HOST_URL --skipSnykMonitoredRepos
  • I want tp map ALL the orgs in Github Enterprise and not only the ones I have operate rights to => add the --fetchAllOrgs flag to the command:
snyk-scm-contributors-count github-enterprise --token TOKEN --url HOST_URL --fetchAllOrgs
  • I want to exclude some contributors from being counted in the commits => add an exclusion file with the emails to ignore(seperated by commas) and apply the --exclusionFilePath with the path to that file to the command:
snyk-scm-contributors-count github-enterprise --token TOKEN --url HOST_URL --orgs ORG_ONE,ORG_TWO --exclusionFilePath PATH_TO_FILE
  • I want the output to be in json format => add the --json flag to the command:
snyk-scm-contributors-count github-enterprise --token TOKEN --url HOST_URL --json
  • I want to run in debug mode for verbose output => add DEBUG=snyk* to the beginning of the command:
DEBUG=snyk* snyk-scm-contributors-count github-enterprise --token TOKEN --url HOST_URL --orgs ORG --repo REPO --exclusionFilePath PATH_TO_FILE --json