v6: Update README on name normalization breaking change (#22)

qetza · Mar 19, 2024 · 4d825ee · 4d825ee
1 parent 3dd89c0
commit 4d825ee
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -9,9 +9,9 @@ Please refer to the [release page](https://github.com/qetza/replacetokens-task/r
 ## Breaking changes in v6
 The task was completely rewritten to use the npm package [@qetza/replacetokens](https://www.npmjs.com/package/@qetza/replacetokens) and be more similar with the new [ReplaceTokens GitHub Actions](https://github.com/marketplace/actions/replacetokens):
   - support only node 16 (mininum agent version 2.206.1)
-  - updated to [fast-glob](https://github.com/mrmlnc/fast-glob) for glob pattern
+  - tokens **must** match real variable names and not normalized names done by the Azure Pipelines agent (token `BUILD_DEFINITIONNAME` will **not** match build variable `Build.DefinitionName`)
   - renamed input _targetFiles_ to _sources_
-  - migrated to `fast-glob` for glob patterns causing syntax changes (must use forward slash (`/`) for directory separator whatever the OS)
+  - migrated to [fast-glob](https://github.com/mrmlnc/fast-glob) for glob patterns causing syntax changes (must use forward slash (`/`) for directory separator whatever the OS)
   - removed support for comma-separated paths in _targetFiles_
   - renamed _encoding_ value `win1252` to `windows1252`
   - renamed _escapeType_ to _escape_

diff --git a/tasks/ReplaceTokensV6/README.md b/tasks/ReplaceTokensV6/README.md
@@ -9,9 +9,9 @@ Please refer to the [release page](https://github.com/qetza/replacetokens-task/r
 ## Breaking changes in v6
 The task was completely rewritten to use the npm package [@qetza/replacetokens](https://www.npmjs.com/package/@qetza/replacetokens) and be more similar with the new [ReplaceTokens GitHub Actions](https://github.com/marketplace/actions/replacetokens):
   - support only node 16 (mininum agent version 2.206.1)
-  - updated to [fast-glob](https://github.com/mrmlnc/fast-glob) for glob pattern
+  - tokens **must** match real variable names and not normalized names done by the Azure Pipelines agent (token `BUILD_DEFINITIONNAME` will **not** match build variable `Build.DefinitionName`)
   - renamed input _targetFiles_ to _sources_
-  - migrated to `fast-glob` for glob patterns causing syntax changes (must use forward slash (`/`) for directory separator whatever the OS)
+  - migrated to [fast-glob](https://github.com/mrmlnc/fast-glob) for glob patterns causing syntax changes (must use forward slash (`/`) for directory separator whatever the OS)
   - removed support for comma-separated paths in _targetFiles_
   - renamed _encoding_ value `win1252` to `windows1252`
   - renamed _escapeType_ to _escape_