Skip to content

Latest commit

 

History

History
144 lines (107 loc) · 5.55 KB

README.md

File metadata and controls

144 lines (107 loc) · 5.55 KB
Raw

Snyk SCM Contributors counting

Inactively Maintained

This repository is in maintenance mode, no new features are being developed. Bug & security fixes will continue to be delivered. Open source contributions are welcome for small features & fixes (no breaking changes)

This tool is used to count contributors with commits in the last 90 days in repositories matching the following criteria:

  1. Repo name XYZ (single repo mode if available for SCM command - see help)
  2. All repos in given projects/org/group (ex: Bitbucket Server project(s))
  3. All repos in given projects/org/group (ex: Bitbucket Server project(s)) AND monitored by Snyk
  4. All repos in SCM (varies a little depending on SCM)
  5. All repos in SCM (varies a little depending on SCM) AND monitored by Snyk

Example

I want to know the countributors count for Snyk monitored projects in bitbucket server project key AN.

Installation

Require node 14 !

npm i -g snyk-scm-contributors-count

or use corresponding binaries in the release page

Link to full documetation

Snyk Docs

Usage

For Azure, Bitbucket Cloud and Bitbucket Server, you need to export your Snyk Token or apply the --skipSnykMonitoredRepos flag:

export SNYK_TOKEN=<YOUR-SNYK-TOKEN>
snyk-scm-contributors-count <command> <command-options>

If using binaries, chmod +x snyk-scm-contributors-count-<env> to allow execution If you can't type snyk-scm-contributors-count in your terminal, then add you bin folder to the PATH in ~/.bash_profile or equivalent. If using nvm, make sure the bin folder for your node version is also in the PATH.

For running the executable on Windows, you need to set the value of the env variable SNYK_TOKEN first

set SNYK_TOKEN=<YOUR-SNYK-TOKEN>
snyk-scm-contributors-count <command> <command-options>
Examples:
snyk-scm-contributors-count bitbucket-server --token BITBUCKET-TOKEN --url http://bitbucket-server.mycompany.com --projectKeys Key1,Key2 --exclusionFilePath=./snyk.exclude

snyk-scm-contributors-count bitbucket-cloud --user USERNAME --password PASSWORD --workspaces Workspace1,Workspace2 --repo Repo --skipSnykMonitoredRepos

snyk-scm-contributors-count azure-devops --token AZURE-TOKEN --org AZURE-ORG --projectKeys ProjectKey1 --json

snyk-scm-contributors-count gitlab --token TOKEN --url URL --exclusionFilePath PATH_TO_FILE --json

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

snyk-scm-contributors-count github-enterprise --token TOKEN --orgs ORG1,ORG2
Walkthroughs:

Common options across commands

  • --exclusionFilePath pointing to snyk.exclude file, simple text file containing emails of committers to exclude (i.e [email protected], etc...)
  • --json output JSON

Additional options might be available depending on the command

Common options across the Bitbucket Cloud, Bitbucket server and Azure Devops commands

  • --skipSnykMonitoredRepos to skip checking with repos that are monitored by Snyk (useful for sizing before Snyk rollout). In that case the SNYK_TOKEN is not required (This flag is auto-applied to the Gitlab command)

Run in DEBUG MODE

Use DEBUG=snyk* env var before your command, for example:

DEBUG=snyk* snyk-scm-contributors-count bitbucket-server --token BITBUCKET-TOKEN --url http://bitbucket-server.mycompany.com --projectKeys Key1,Key2 --exclusionFilePath=./snyk.exclude

Run in DEBUG MODE (On WINDOWS)

Set the value of env var as DEBUG=snyk* before your command, for example:

set DEBUG=snyk* 
snyk-scm-contributors-count bitbucket-server --token BITBUCKET-TOKEN --url http://bitbucket-server.mycompany.com --projectKeys Key1,Key2 --exclusionFilePath=./snyk.exclude

Development

Add a command and SCM support

  1. Create a new ts file under cmds (duplicate cmds/bitbucket-server.ts)

  2. Fill out command, desc, and builder options, leaving in:

  • exclusionFilePath
  • json
  • skipSnykMonitoredRepos

  1. The handler function will be called with argv which should match the builder options

  2. Create a class with your command name extending SCMHandlerClass. It'll require you to implement the abstract method fetchSCMContributors expecting a Promise<ContributorMap> in return

  • types can be function in src/lib/types.ts

  1. Once create and asbtract function implemented, in handler, instantiate the class you just created

  2. Call

<classInstance>.scmContributorCount(argv.url,SourceType["YOUR-SOURCE"],argv.skipSnykMonitoredRepos,argv.exclusionFilePath,argv.json)
  1. profit.

Build

npm run build

or in watch mode

npm run build-watch

Best Practices

  • Most SCMs have paginated results, fetch all the relevant pages, only what's useful
  • Be gentle with rates against SCM. Use client or throttling libs like bottleneck
  • Snyk API interaction is using snyk-api-ts-client with built-in throttling and retries

Note of rate and other limitations

  • Please be aware that all the SCMs have an API rate limit control. The tool takes that into account.