Introduction

The xReleaseManagement module is a set of DSC resources that extend Release Management for Visual Studio.

This module currently includes 1 DSC resource to transform files based on a token file for use with Release Management for Visual Studio.

• xTokenize transforms files based on a token file for Release Management

All of the resources in the DSC Resource Kit are provided AS IS, and are not supported through any Microsoft standard support program or service. The "x" in xReleaseManagement stands for experimental, which means that these resources will be fix forward and monitored by the module owner(s).

Please leave comments, feature requests, and bug reports in the Q & A tab for this module.

If you would like to modify xReleaseManagement module, feel free. When modifying, please update the module name, resource friendly name, and MOF class name (instructions below). As specified in the license, you may copy or modify this resource as long as they are used on the Windows Platform.

For more information about Windows PowerShell Desired State Configuration, check out the blog posts on the PowerShell Blog (this is a good starting point). There are also great community resources, such as PowerShell.org , or PowerShell Magazine . For more information on the DSC Resource Kit, check out this blog post.

Installation

To install xReleaseManagement module

• If you are using WMF4 / PowerShell Version 4: Unzip the content under $env:ProgramFiles\WindowsPowerShell\Modules folder
• If you are using WMF5 Preview: From an elevated PowerShell session run ‘Install-Module xReleaseManagement’

To confirm installation:

• Run Get-DSCResource to see that xTokenize is among the DSC Resources listed

Requirements

This module requires the latest version of PowerShell (v4.0, which ships in Windows 8.1 or Windows Server 2012R2). To easily use PowerShell 4.0 on older operating systems, install WMF 4.0. Please read the installation instructions that are present on both the download page and the release notes for WMF 4.0.

Details

xTokenize resource has following properties:

• Path:   Path under which a search will be performed to locate files to transform.
• Recurse:   A flag to indicate if a recursive search of the path should be performed. The default value is false.
• SearchPattern:   Defines the pattern to use when searching for files. The default value is '*.*'.
• Tokens:   A hash table of tokens with their values.
• UseTokenFiles:   A flag indicating if a token file is provided. Tokenization can occur with or without a token file. The default value is true.

Renaming Requirements

When making changes to these resources, we suggest the following practice:

1. Update the following names by replacing MSFT with your company/community name and replacing the "x" with "c" (short for "Community") or another prefix of your choice:
   • Module name (ex: xReleaseManagement becomes cReleaseManagement)
   • Resource folder (ex: MSFT_xTokenize becomes Contoso_cTokenize)
   • Resource file name (ex: MSFT_xTokenize becomes Contoso_cTokenize)
   • Resource Friendly Name (ex: xTokenize becomes cTokenize)
   • MOF class name (ex: MSFT_xTokenize becomes Contoso_cTokenize)
   • Filename for the <resource>.schema.mof (ex: MSFT_xTokenize.schema.mof becomes Contoso_cTokenize.schema.mof)
2. Update module and metadata information in the module manifest
3. Update any configuration that use these resources

We reserve resource and module names without prefixes ("x" or "c") for future use (e.g. "MSFT_**RealResourceName**" or "**RealResourceName**"). If the next version of Windows Server ships with a "**RealResourceName**" resource, we don't want to break any configurations that use any community modifications. Please keep a prefix such as "c" on all community modifications.

Versions

1.0.0.0

• Introduce xTokenize

Examples

The 'Examples' folder within the payload includes example configurations for common work streams:

• No Token File - This script supports using the technique where you only copy a tokenized web.config file.
• With Token File - This script supports using the technique where you copy both the web.config and a web.config.token file.