@soos-io/soos-scm-audit 0.0.3 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -28,6 +28,19 @@ NOTE: you can find values for the `--apiKey` and `--clientId` at [app.soos.io](h
|
|
|
28
28
|
#### When Installed Locally:
|
|
29
29
|
`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>"`
|
|
30
30
|
|
|
31
|
+
### For Bitbucket Cloud
|
|
32
|
+
1. Generate an App Password for your organization and ensure that it has the Read `Repositories` permission set.
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
2. Plug in the values for `--apiKey`, `--clientId`, `--secret`, and `--workspace`, and `--username` and run the script.
|
|
37
|
+
|
|
38
|
+
#### When Installed Globally:
|
|
39
|
+
`soos-scm-audit --apiKey=<API_KEY> --clientId=<CLIENT_ID> --scmType=BitbucketCloud --secret=<APP_PASSWORD> --workspace="<BITBUCKET_WORKSPACE>" --username="<BITBUCKET_USERNAME>"`
|
|
40
|
+
|
|
41
|
+
#### When Installed Locally:
|
|
42
|
+
`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>"`
|
|
43
|
+
|
|
31
44
|
|
|
32
45
|
## Parameters
|
|
33
46
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@soos-io/soos-scm-audit",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.4",
|
|
4
4
|
"description": "SOOS SCM Audit CLI",
|
|
5
5
|
"main": "bin/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
},
|
|
29
29
|
"homepage": "https://github.com/soos-io/soos-scm-audit#readme",
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@soos-io/api-client": "0.2.
|
|
31
|
+
"@soos-io/api-client": "0.2.44",
|
|
32
32
|
"argparse": "^2.0.1",
|
|
33
33
|
"tslib": "^2.6.2"
|
|
34
34
|
},
|