@cesar-richard/git-connector-sdk 1.33.0 → 1.33.1

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 (2) hide show
  1. package/README.md +40 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -194,6 +194,46 @@ for (const wi of data.items) {
194
194
 
195
195
  GitLab resolution uses a 90-day cache (configurable via `GITLAB_USER_CACHE_TTL_DAYS`).
196
196
 
197
+ ### Issue ↔ PR/MR link detection patterns
198
+
199
+ `WorkItem.linkedActivities` is populated by scanning PR/MR bodies, commit
200
+ messages, notes, AND issue comments for references to PR/MR numbers or URLs.
201
+ The recognized patterns are:
202
+
203
+ **Canonical (in PR/MR body / commits / notes — forward direction):**
204
+
205
+ - `Fixes #1234`, `Fix #1234`, `Closes #1234`, `Close #1234`, `Resolves #1234`,
206
+ `Resolve #1234` (English short refs).
207
+ - `https://github.com/<owner>/<repo>/issues/<n>` or `https://<gitlab>/.../-/issues/<n>`
208
+ (full URLs).
209
+ - `<owner>/<repo>#<n>` (cross-repo GitHub).
210
+ - `<alias>#<n>` and `<alias>!<n>` (project-alias cross-repo).
211
+ - Short refs `#<n>` and `!<n>` (resolved against the active provider/project).
212
+
213
+ **Issue-comment reverse direction (`hint_source="issue_comment"`):**
214
+
215
+ The above PR/MR URLs and short refs are all recognized in **issue comments**
216
+ as evidence that the cited PR/MR is linked to the issue.
217
+
218
+ Additionally, the following **explicit phrase prefixes** are recognized,
219
+ case-insensitively, to catch informal "this issue was delivered" comments:
220
+
221
+ | Phrase | Example | Behavior |
222
+ |---|---|---|
223
+ | `Fixed by …`, `Fixed in …` | `Fixed by 1214`, `Fixed by https://…/pull/1214` | Treat the cited ref as a linked PR/MR |
224
+ | `Fixes by …`, `Fix by …` | `Fix by #99` | Same |
225
+ | `Resolved by …`, `Resolves by …`, `Resolve by …` | `Resolved by 42` | Same |
226
+ | `Closed by …`, `Closes by …`, `Close by …` | `Closed by !99` | Same |
227
+ | FR: `Corrigé par …`, `Corrigée par …`, `Corrige par …` | `Corrigé par 42` | Same |
228
+ | FR: `Résolu par …`, `Resolu par …` | `Résolu par !99` | Same |
229
+ | FR: `Fermé par …`, `Ferme par …` | `Fermé par #1214` | Same |
230
+ | FR: `… dans <n>` variant | `Corrigé dans 42` | Same |
231
+
232
+ The phrase prefix lets the SDK detect refs even when the number is **bare**
233
+ (no `#` or `!` prefix), e.g. `Fixed by 1214` instead of `Fixed by #1214`.
234
+
235
+ Code blocks (fenced ```` ``` ```` and inline `` ` ``) are stripped before scanning.
236
+
197
237
  ### PR review status (`reviewStatus`)
198
238
 
199
239
  Each `LinkedActivity` carries an optional `reviewStatus` field with 8 possible
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cesar-richard/git-connector-sdk",
3
- "version": "1.33.0",
3
+ "version": "1.33.1",
4
4
  "description": "TypeScript SDK for the git-connector v1 API (work items + iterations aggregated from GitHub/GitLab). Version published on npm tracks server releases.",
5
5
  "license": "MIT",
6
6
  "repository": {