@soos-io/soos-scm-audit v0.2.8

SOOS

The SOOS SCM Audit script should be used to determine the number of contributing developers in your organization.

SOOS Badge Status

Requirements

• Node 20 LTS

Installation

run npm install --prefix ./soos @soos-io/soos-scm-audit

Configure and Run the Script

NOTE: you can find values for the --apiKey and --clientId at app.soos.io.

For GitHub

1. Generate a GitHub Public Access Token (PAT) for your organization and ensure that it has the full repo permission set.

2. Plug in the values for --apiKey, --clientId, --secret, and --organizationName and run the script.

3. Run node ./soos/node_modules/@soos-io/soos-scm-audit/bin/index.js --apiKey=<API_KEY> --clientId=<CLIENT_ID> --scmType=GitHub --secret=<GITHUB_PAT> --organizationName="<GITHUB_ORG_NAME>"

For Bitbucket Cloud

1. Generate an App Password for your organization and ensure that it has the Read Repositories permission set.

2. Plug in the values for --apiKey, --clientId, --secret, and --workspace, and --username and run the script.

3. Run node ./soos/node_modules/@soos-io/soos-scm-audit/bin/index.js --apiKey=<API_KEY> --clientId=<CLIENT_ID> --scmType=BitbucketCloud --secret=<APP_PASSWORD> --workspace="<BITBUCKET_WORKSPACE>" --username="<BITBUCKET_USERNAME>"

Parameters