AzureDevOpsDemoGenerator/docs/Using-The-Template-Extractor.md

Using the Extractor

Azure DevOps Generator provides a number of templates, out of the box, that supports a wide variety of scenarios, from different project types to different programming languages, deployment platforms, etc., In addition to this, the generator also allows users to make their own templates. Users can convert their existing projects into templates and then provision new projects using that template. The ability to have custom templates can be useful in many scenarios, such as building custom training materials, provision only certain artifacts, etc.,

This document walks you through the steps on how you can use the extractor.

Before you start

Setup an Azure DevOps project and make sure it is ready to be extracted. The extractor will capture the contents of the project and save them as JSON files which will be archived into a zip file.

Building a new custom template

1. Access the generator with the query parameter "enableextractor=true" added to the URL: https://azuredevopsdemogenerator.azurewebsites.net/?enableextractor=true

   

2. After you sign in, on the main page, you will see a new link labelled "Build your own template"

   

3. Selecting that will open the extractor main page in a new tab.

   

4. Select the organization and then the project that you want to turn into a template.

5. Click Analyze. This will validate if the project is one of the supported types (only Agile and Scrum based projects are supported for the time-being) and that all of the contents can be read.At the end of the analysis, you will see the artifacts and count of items for you to confirm if the extractor has read all items correctly.

   

6. If it is correct and you wish to proceed, select the Generate button. This will again read all the items from the project but this time, the contents will be saved as JSON data. After all the items have been extracted, the folder will be archived into a zip file.

7. Select the link to download the zip file. Note that the zip file is not stored on the server side - so, make sure you download the file. It will not be available after you close the page.

   

Note: The Extractor does not support all item types and so it should not be considered as a migration tool for moving projects from one server to another. For what's supported and what's not supported, see the limitations section

Provisioning your project from your custom template

1. Return back to the generator page or re-open it again if you have already closed it.

2. Select Choose Template

3. You will see a new tab labelled Private. Select the tab.

   Here you have three option

   1. Select Browse and select the zip file you downloaded zip file.

   2. Use the radio button GitHub to consume the private template from a github raw URL

   3. Use the radio button URL to consume the private template from other sources

4. Once you point the right template, click Submit to validate and pick the template for provisoning the project

5. Choose Create Project to start provisioning a project

---

Previous: Using the Generator

Next: Using Private template URL