Skip to content

Commit e2c3e78

Browse files
committed
docs(README.md): add detailed explanation for target query and its parameters to improve documentation clarity
1 parent c58d563 commit e2c3e78

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,20 @@ Clones work items from a template project to a target project incorproating a JS
3434
- `--targetOrganization` - The name of the organisation to clone work items to.
3535
- `--targetProject` - The name of the prject to clone work items to.
3636
- `--targetParentId` - All cloned work items will be come a child of this work item
37+
38+
*Target Query* - The target query is used to create a query in the target project to show the cloned work items.
39+
3740
- `--targetQuery` - The query to create in the target project. Default is `SELECT [System.Id], [System.WorkItemType], [System.Title], [System.AreaPath],[System.AssignedTo],[System.State] FROM workitems WHERE [System.Parent] = @projectID`.
3841
- `--targetQueryTitle` - The title of the query to create in the target project. Default is `Project-@RunName - @projectTitle`.
3942
- `--targetQueryFolder` - The folder to create the query in the target project. Default is `Shared Queries`.
4043

44+
You can use the following parameters:
45+
46+
- *@projectID* - The ID of the target parent item
47+
- *@projectTitle* - The title of the parent item
48+
- *@projectTags* - the tags of the item
49+
- *@RunName* - The name of the run
50+
4151
*Optional Parameters* - These are optional parameters that can be used to control the behaviour of the clone process.
4252

4353
- `--NonInteractive` - Disables interactive mode. Default is `false`.

0 commit comments

Comments
 (0)