-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from nkdAgility/topic/update-docs
These are the new docs
- Loading branch information
Showing
2 changed files
with
136 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
|  | ||
| # Azure DevOps WorkItem Clone | ||
|
|
||
| The purpose of this tool is to clone work items from a template project to a target project. The tool uses a JSON configuration file which it combines with a template in Azure DevOps to specify what work items to create and how to update them. | ||
|
|
||
| ## Installation | ||
|
|
||
| Download the [latest release](https://github.com/nkdAgility/Azure-DevOps-WorkItem-Clone/releases/latest) from the [releases page](https://github.com/nkdAgility/Azure-DevOps-WorkItem-Clone/releases), unzip, and run `WorkItemClone.exe` with the appropriate parameters. | ||
|
|
||
| ## Commands | ||
|
|
||
| ### `clone` | ||
|
|
||
| Clones work items from a template project to a target project incorproating a JSON configuration file specificyng what work items to create and how to update them. | ||
|
|
||
| #### Parameters | ||
|
|
||
| *General Parameters* - These are general parameters that control the behaviour of the clone process. | ||
|
|
||
| - `--config` - The path to the configuration file. Default is `.\configuration.json`. This can be used to had code paramiters... Command line params overrides the configuration file. | ||
| - `--CachePath` - Folder used to cache data like the template. Default is `.\cache`. | ||
| - `--inputJsonFile` - The path to the JSON file that instructs the creation of the work items | ||
|
|
||
| *Template Parameters* - The template contains the Descrition, Acceptance Criteria and relationship to other work itsm that we will clone. | ||
|
|
||
| - `--templateAccessToken` - The access token for the template instance. | ||
| - `--templaterganization` - The name of the organisation to clone work items to. | ||
| - `--templateProject` - The name of the prject to clone work items from. | ||
|
|
||
| *Target Parameters* - The target environemnt is where we will clone the work items to. | ||
|
|
||
| - `--targetAccessToken` - The access token for the target project. | ||
| - `--targetOrganization` - The name of the organisation to clone work items to. | ||
| - `--targetProject` - The name of the prject to clone work items to. | ||
| - `--targetParentId` - All cloned work items will be come a child of this work item | ||
|
|
||
| *Optional Parameters* - These are optional parameters that can be used to control the behaviour of the clone process. | ||
|
|
||
| - `--NonInteractive` - Disables interactive mode. Default is `false`. | ||
| - `--ClearCache` - Clears the cache. Default is `false`. | ||
|
|
||
| *Typical usage*: | ||
|
|
||
| ```powershell | ||
| clone --inputJsonFile ..\\..\\..\\..\\TestData\\ADO_TESTProjPipline_V03.json --targetParentId 540 --templateAccessToken tqvemdfaucsriu6e3uti7dya --targetAccessToken ay5xc2kn5i3xcsmw5fu65ja | ||
| ``` | ||
|
|
||
| ### `init` | ||
|
|
||
| Leads you through the process of creating a configuration file. | ||
|
|
||
| #### Parameters | ||
|
|
||
| *General Parameters* - These are general parameters that control the behaviour of the clone process. | ||
|
|
||
| - `--config` - The path to the configuration file. Default is `.\configuration.json`. This can be used to had code paramiters... Command line params overrides the configuration file. | ||
|
|
||
| *Typical usage*: | ||
|
|
||
| ```powershell | ||
| init --config configuration.json | ||
| ``` | ||
|
|
||
| ## Configuration Example | ||
|
|
||
| ```json | ||
| { | ||
| "CachePath": "./cache", | ||
| "inputJsonFile": "ADO_TESTProjPipline_V03.json", | ||
| "targetAccessToken": null, | ||
| "targetOrganization": "nkdagility-preview", | ||
| "targetProject": "Clone-Demo", | ||
| "targetParentId": 540, | ||
| "templateAccessToken": null, | ||
| "templateOrganization": "Clone-MO-ATE", | ||
| "templateProject": "Clone Template" | ||
| } | ||
| ``` | ||
|
|
||
| ## inputJsonFile Example | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "id": 213928, | ||
| "area": "TPL", | ||
| "tags": "Customer Document", | ||
| "fields": { | ||
| "title": "Technical specification", | ||
| "product": "CC000_000A01" | ||
| } | ||
| }, | ||
| { | ||
| "id": 213928, | ||
| "area": "TPL", | ||
| "tags": "Customer Document", | ||
| "fields": { | ||
| "title": "Technical specification", | ||
| "product": "CC000_000A02" | ||
| } | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| proposed new format not yet adopted: | ||
|
|
||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "templateId": 213928, | ||
| "fields": [ | ||
| {"System.Title": "Technical specification"}, | ||
| {"Custom.Project": "CC000_000A01"}, | ||
| {"System.Tags": "Customer Document"}, | ||
| {"System.AreaPath": "#{targetProject}#\\TPL"} | ||
| ] | ||
| }, | ||
| { | ||
| "templateId": 213928, | ||
| "fields": [ | ||
| {"System.Title": "Technical specification"}, | ||
| {"Custom.Project": "CC000_000A02"}, | ||
| {"System.Tags": "Technical specification"}, | ||
| {"System.AreaPath": "#{targetProject}#\\TPL"} | ||
| ] | ||
| }, | ||
| } | ||
| ] | ||
| ``` | ||
|
|