@o3r/azure-tools 10.0.0-prerelease.7 → 10.0.0-prerelease.71

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.
Files changed (4) hide show
  1. package/README.md +32 -8
  2. package/package.json +13 -9
  3. package/src/cli/comment-pr.js +1 -1
  4. package/src/cli/comment-pr.js.map +1 -1
package/README.md CHANGED
@@ -5,30 +5,54 @@
5
5
 
6
6
  ## Description
7
7
 
8
- Various Azure DevOps tools
8
+ This module provides a tool to comment a Pull Request on Azure.
9
9
 
10
10
  ## Comment Azure PR
11
11
 
12
12
  ### Usage
13
13
 
14
14
  ```shell
15
- yarn dlx -p @o3r/azure-tools o3r-comment-pr "[Deployed app]($(url))" -s Closed -I app-link -m Replace -T $(System.AccessToken)
15
+ yarn dlx -p @o3r/azure-tools o3r-comment-pr <comment> [options]
16
16
  ```
17
-
18
17
  or
19
-
20
18
  ```shell
21
- npx -p @o3r/azure-tools o3r-comment-pr "[Deployed app]($(url))" -s Closed -I app-link -m Replace -T $(System.AccessToken)
19
+ npx -p @o3r/azure-tools o3r-comment-pr <comment> [options]
22
20
  ```
23
21
 
24
- ### Options available
22
+ The required options include:
23
+ * the access token (`--accessToken <accessToken>`)
24
+ * the thread identifier (`--threadIdentifier <threadIdentifier>`)
25
+
26
+ Additionally, the following environment variables must be provided:
27
+ * `SYSTEM_TEAMPROJECT` (`System.TeamProject` in Azure)
28
+ * `BUILD_REPOSITORY_NAME` (`Build.Repository.Name` in Azure)
29
+ * `SYSTEM_PULLREQUEST_PULLREQUESTID` (must be a number) (`System.PullRequest.PullRequestId` in Azure)
30
+ * `SYSTEM_TEAMFOUNDATIONCOLLECTIONURI` (`System.TeamFoundationCollectionUri` in Azure)
31
+
32
+ #### Arguments
33
+
34
+ | Argument | Description |
35
+ |-----------|------------------------------------|
36
+ | `comment` | Comment to publish on the Azure PR |
37
+
38
+ #### Options
39
+
40
+ | Option | Alias | Value Type | Value Options | Default Value | Description |
41
+ |---------------------------------------------------|:-----:|------------|--------------------------------------------------------------------------------------------------|---------------|------------------------------------------------------------------------------------------------------------------|
42
+ | `--accessToken <accessToken>` <br> **(Required)** | `-T` | `string` | | | Access token (Required) |
43
+ | `--commentStatus <commentStatus>` | `-s` | `string` | `Unknown` <br> `Active` <br> `Fixed` <br> `WontFix` <br> `Closed` <br> `ByDesign` <br> `Pending` | `Closed` | Comment status |
44
+ | `--mode <mode>` | `-m` | `string` | `Replace` <br> `Add` <br> `Skip` | `Add` | Replaces thread if existing <br> Adds a comment to the existing thread <br> Do anything if thread already exists |
45
+ | `--threadIdentifier <threadIdentifier>` | `-I` | `string` | | | Thread identifier |
46
+ | `--help` | `-h` | | | | Output usage information |
47
+
48
+ ### Example
25
49
 
26
50
  ```shell
27
- yarn dlx -p @o3r/azure-tools o3r-comment-pr --help
51
+ yarn dlx -p @o3r/azure-tools o3r-comment-pr "[Deployed app]($(url))" -s Closed -I app-link -m Replace -T $(System.AccessToken)
28
52
  ```
29
53
 
30
54
  or
31
55
 
32
56
  ```shell
33
- npx -p @o3r/azure-tools o3r-comment-pr --help
57
+ npx -p @o3r/azure-tools o3r-comment-pr "[Deployed app]($(url))" -s Closed -I app-link -m Replace -T $(System.AccessToken)
34
58
  ```
package/package.json CHANGED
@@ -1,6 +1,9 @@
1
1
  {
2
2
  "name": "@o3r/azure-tools",
3
- "version": "10.0.0-prerelease.7",
3
+ "version": "10.0.0-prerelease.71",
4
+ "publishConfig": {
5
+ "access": "public"
6
+ },
4
7
  "description": "Various Azure DevOps tools",
5
8
  "keywords": [
6
9
  "otter",
@@ -16,11 +19,11 @@
16
19
  "build:builders": "tsc -b tsconfig.builders.json --pretty && yarn generate-cjs-manifest"
17
20
  },
18
21
  "bin": {
19
- "o3r-comment-pr": "src/cli/comment-pr.js"
22
+ "o3r-comment-pr": "./src/cli/comment-pr.js"
20
23
  },
21
24
  "dependencies": {
22
25
  "azure-devops-node-api": "^12.0.0",
23
- "commander": "^11.0.0",
26
+ "commander": "^12.0.0",
24
27
  "tslib": "^2.5.3",
25
28
  "winston": "^3.8.2"
26
29
  },
@@ -31,10 +34,11 @@
31
34
  "@babel/core": "~7.23.0",
32
35
  "@babel/preset-typescript": "~7.23.0",
33
36
  "@compodoc/compodoc": "^1.1.19",
34
- "@nx/eslint-plugin": "~17.2.0",
35
- "@nx/jest": "~17.2.0",
36
- "@o3r/build-helpers": "^10.0.0-prerelease.7",
37
- "@o3r/eslint-plugin": "^10.0.0-prerelease.7",
37
+ "@nx/eslint-plugin": "~18.0.2",
38
+ "@nx/jest": "~18.0.2",
39
+ "@o3r/build-helpers": "^10.0.0-prerelease.71",
40
+ "@o3r/eslint-plugin": "^10.0.0-prerelease.71",
41
+ "@stylistic/eslint-plugin-ts": "^1.5.4",
38
42
  "@types/jest": "~29.5.2",
39
43
  "@types/node": "^20.0.0",
40
44
  "@typescript-eslint/eslint-plugin": "^6.19.0",
@@ -45,10 +49,10 @@
45
49
  "eslint-plugin-jest": "~27.6.0",
46
50
  "eslint-plugin-jsdoc": "~48.0.0",
47
51
  "eslint-plugin-prefer-arrow": "~1.2.3",
48
- "eslint-plugin-unicorn": "^50.0.0",
52
+ "eslint-plugin-unicorn": "^51.0.0",
49
53
  "jest": "~29.7.0",
50
54
  "jest-junit": "~16.0.0",
51
- "nx": "~17.2.0",
55
+ "nx": "~18.0.2",
52
56
  "ts-jest": "~29.1.1",
53
57
  "ts-node": "~10.9.1",
54
58
  "typescript": "~5.2.2"
package/src/cli/comment-pr.js CHANGED
@@ -55,7 +55,7 @@ void (async () => {
55
55
  const pullRequestId = +process.env.SYSTEM_PULLREQUEST_PULLREQUESTID;
56
56
  const orgUrl = process.env.SYSTEM_TEAMFOUNDATIONCOLLECTIONURI;
57
57
  const prService = new index_1.PullRequestService(opts.accessToken, project, orgUrl, logger);
58
- const threads = await prService.findThreadsByIdentifier(repositoryId, pullRequestId, opts.threadIdentifier);
58
+ const threads = opts.threadIdentifier ? await prService.findThreadsByIdentifier(repositoryId, pullRequestId, opts.threadIdentifier) : [];
59
59
  if (opts.mode === 'Replace') {
60
60
  await Promise.all(threads.filter(thread => !!thread.id).map((thread) => prService.deleteThread(repositoryId, pullRequestId, thread.id)));
61
61
  }
package/src/cli/comment-pr.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"comment-pr.js","sourceRoot":"","sources":["../../../src/cli/comment-pr.ts"],"names":[],"mappings":";;;AAEA,yCAA4C;AAC5C,mCAAmC;AACnC,4CAAsD;AAEtD,IAAI,OAA2B,CAAC;AAChC;;;GAGG;AACH,mBAAO;KACJ,SAAS,CAAC,WAAW,CAAC;KACtB,WAAW,CAAC,wBAAwB,CAAC;KACrC,SAAS,CAAC,IAAI,kBAAM,CAAC,qCAAqC,EAAE,gBAAgB,CAAC;KAC3E,OAAO,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;KACnF,OAAO,CAAC,QAAQ,CAAC,CACnB;KACA,SAAS,CAAC,IAAI,kBAAM,CAAC,mBAAmB,EAAE,4GAA4G,CAAC;KACrJ,OAAO,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;KACnC,OAAO,CAAC,KAAK,CAAC,CAChB;KACA,MAAM,CAAC,2CAA2C,EAAE,mBAAmB,EAAE,SAAS,CAAC;KACnF,cAAc,CAAC,iCAAiC,EAAE,cAAc,CAAC;KACjE,MAAM,CAAC,CAAC,aAAqB,EAAE,EAAE;IAChC,4CAA4C;IAC5C,OAAO,GAAG,aAAa,CAAC;AAC1B,CAAC,CAAC;KACD,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvB,MAAM,IAAI,GAAG,mBAAO,CAAC,IAAI,EAAE,CAAC;AAE5B,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAClC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE;IAC/B,UAAU,EAAE,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE;CAC7C,CAAC,CAAC;AAEH,KAAK,CAAC,KAAK,IAAI,EAAE;IACf,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAEhC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC/C;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE;QACnC,MAAM,KAAK,CAAC,qCAAqC,CAAC,CAAC;KACpD;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE;QACtC,MAAM,KAAK,CAAC,wCAAwC,CAAC,CAAC;KACvD;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE;QACjD,MAAM,KAAK,CAAC,mDAAmD,CAAC,CAAC;KAClE;SAAM,IAAI,KAAK,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,EAAE;QAC/D,MAAM,KAAK,CAAC,mDAAmD,CAAC,CAAC;KAClE;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE;QACnD,MAAM,KAAK,CAAC,qDAAqD,CAAC,CAAC;KACpE;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;IAC/C,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;IACvD,MAAM,aAAa,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC;IACpE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC;IAE9D,MAAM,SAAS,GAAG,IAAI,0BAAkB,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACpF,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,uBAAuB,CAAC,YAAY,EAAE,aAAa,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAE5G,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;QAC3B,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,YAAY,EAAE,aAAa,EAAE,MAAM,CAAC,EAAG,CAAC,CAAC,CAAC,CAAC;KAC3I;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QACjD,MAAM,SAAS,CAAC,SAAS,CAAC,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;KAC5G;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,EAAE;QAC9B,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,kBAAkB,CAAC,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAQ,CAAC,CAAC,CACrG,CAAC;KACH;AACH,CAAC,CAAC,EAAE,CAAC"}
1
+ {"version":3,"file":"comment-pr.js","sourceRoot":"","sources":["../../../src/cli/comment-pr.ts"],"names":[],"mappings":";;;AAEA,yCAA4C;AAC5C,mCAAmC;AACnC,4CAAsD;AAEtD,IAAI,OAA2B,CAAC;AAChC;;;GAGG;AACH,mBAAO;KACJ,SAAS,CAAC,WAAW,CAAC;KACtB,WAAW,CAAC,wBAAwB,CAAC;KACrC,SAAS,CAAC,IAAI,kBAAM,CAAC,qCAAqC,EAAE,gBAAgB,CAAC;KAC3E,OAAO,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;KACnF,OAAO,CAAC,QAAQ,CAAC,CACnB;KACA,SAAS,CAAC,IAAI,kBAAM,CAAC,mBAAmB,EAAE,4GAA4G,CAAC;KACrJ,OAAO,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;KACnC,OAAO,CAAC,KAAK,CAAC,CAChB;KACA,MAAM,CAAC,2CAA2C,EAAE,mBAAmB,EAAE,SAAS,CAAC;KACnF,cAAc,CAAC,iCAAiC,EAAE,cAAc,CAAC;KACjE,MAAM,CAAC,CAAC,aAAqB,EAAE,EAAE;IAChC,4CAA4C;IAC5C,OAAO,GAAG,aAAa,CAAC;AAC1B,CAAC,CAAC;KACD,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvB,MAAM,IAAI,GAAG,mBAAO,CAAC,IAAI,EAAE,CAAC;AAE5B,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAClC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE;IAC/B,UAAU,EAAE,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE;CAC7C,CAAC,CAAC;AAEH,KAAK,CAAC,KAAK,IAAI,EAAE;IACf,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAEhC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC/C;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE;QACnC,MAAM,KAAK,CAAC,qCAAqC,CAAC,CAAC;KACpD;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE;QACtC,MAAM,KAAK,CAAC,wCAAwC,CAAC,CAAC;KACvD;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE;QACjD,MAAM,KAAK,CAAC,mDAAmD,CAAC,CAAC;KAClE;SAAM,IAAI,KAAK,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,EAAE;QAC/D,MAAM,KAAK,CAAC,mDAAmD,CAAC,CAAC;KAClE;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE;QACnD,MAAM,KAAK,CAAC,qDAAqD,CAAC,CAAC;KACpE;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;IAC/C,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;IACvD,MAAM,aAAa,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC;IACpE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC;IAE9D,MAAM,SAAS,GAAG,IAAI,0BAAkB,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACpF,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,uBAAuB,CAAC,YAAY,EAAE,aAAa,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAEzI,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;QAC3B,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,YAAY,EAAE,aAAa,EAAE,MAAM,CAAC,EAAG,CAAC,CAAC,CAAC,CAAC;KAC3I;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QACjD,MAAM,SAAS,CAAC,SAAS,CAAC,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;KAC5G;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,EAAE;QAC9B,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,kBAAkB,CAAC,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAQ,CAAC,CAAC,CACrG,CAAC;KACH;AACH,CAAC,CAAC,EAAE,CAAC"}