ado-sync 0.1.23 → 0.1.24

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 +7 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -17,7 +17,7 @@ Local files ado-sync Azure DevOps
17
17
  .csv files ── push ──► (push-only)
18
18
  .xlsx files ── push ──► (push-only)
19
19
  write ID back
20
- @tc:12345 / <!-- tc: 12345 --> / col A
20
+ @tc:12345 / col A (csv/xlsx)
21
21
  ```
22
22
 
23
23
  On the **first push** of a scenario, a new Test Case is created in Azure DevOps and its ID is written back into the local file as a tag or comment. Every subsequent push uses that ID to update the existing Test Case. Pulling fetches the latest title and steps from Azure and overwrites the local file.
@@ -334,7 +334,7 @@ After a scenario is pushed for the first time, ado-sync writes the Azure Test Ca
334
334
  | Format | Writeback location |
335
335
  |--------|--------------------|
336
336
  | Gherkin | `@tc:12345` tag above the `Scenario:` line |
337
- | Markdown | `<!-- tc: 12345 -->` comment after the `### heading` |
337
+ | Markdown | `@tc:12345` tag after the `### heading` |
338
338
  | CSV | Numeric ID in column A of the matching title row |
339
339
  | Excel | Numeric ID in cell A of the matching title row |
340
340
 
@@ -368,11 +368,11 @@ For `Scenario Outline`, a **single** parametrized Test Case is created in Azure
368
368
 
369
369
  ### Markdown
370
370
 
371
- The ID comment is inserted on the line immediately after the `### heading`:
371
+ The ID tag is inserted on the line immediately after the `### heading`:
372
372
 
373
373
  ```markdown
374
374
  ### 1. Login (happy path)
375
- <!-- tc: 1042 -->
375
+ @tc:1042
376
376
 
377
377
  Assumption: Fresh browser session.
378
378
 
@@ -388,8 +388,6 @@ Expected results:
388
388
  ---
389
389
  ```
390
390
 
391
- The comment is invisible when the Markdown is rendered.
392
-
393
391
  ### Custom prefix
394
392
 
395
393
  Change the `sync.tagPrefix` in your config to use a different prefix:
@@ -400,7 +398,7 @@ Change the `sync.tagPrefix` in your config to use a different prefix:
400
398
 
401
399
  Result:
402
400
  - Gherkin: `@azure:1042`
403
- - Markdown: `<!-- azure: 1042 -->`
401
+ - Markdown: `@azure:1042`
404
402
 
405
403
  > **Warning:** Changing the prefix on an existing project means all existing ID tags will no longer be recognised. Do a project-wide find-and-replace on the old prefix before changing it.
406
404
 
@@ -449,7 +447,7 @@ Add a `<!-- tags: -->` HTML comment anywhere inside a scenario block to assign t
449
447
 
450
448
  ```markdown
451
449
  ### Login with valid credentials
452
- <!-- tc: 1042 -->
450
+ @tc:1042
453
451
  <!-- tags: @smoke, @regression -->
454
452
 
455
453
  Steps:
@@ -644,7 +642,7 @@ Tags matching a configured `links` prefix are turned into Azure DevOps work item
644
642
 
645
643
  ```markdown
646
644
  ### User can add items to cart
647
- <!-- tc: 1042 -->
645
+ @tc:1042
648
646
  <!-- tags: @story:555, @bug:789 -->
649
647
  ```
650
648
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ado-sync",
3
- "version": "0.1.23",
3
+ "version": "0.1.24",
4
4
  "description": "Bidirectional sync between local test specs (Cucumber/Markdown) and Azure DevOps Test Cases",
5
5
  "bin": {
6
6
  "ado-sync": "./dist/cli.js"