Skip to content
Rob Reynolds edited this page Mar 15, 2016 · 12 revisions

WarmuP

Overview

WarmuP allows you to define templates for entire projects and change them as technology changes and you learn new things. The templates are kept in source control. Both SVN and Git are supported places to keep your templates. You can also keep your templates in folders and that is the default methodology used currently.

WarmuP is not just about Visual Studio solutions, it can template any set of text files/folders.

Getting started with WarmuP

###Token Replacement See the following post by Rob - Getting Started.

You define a template using __NAME__ (note the double underscore) as part of file/folder names and inside of files. Then you run WarmuP telling it what you want to replace __NAME__ with.

In the location you want the generated template to reside run:
[warmuppath]warmup template replacementName [targetDirectoryIfDifferentThanReplacementName]
i.e. warmup mvctemplate NewBob

Ensure that the warmup.exe.config has the correct path to your templates.

WarmuP will also replace custom tokens with pre-configured values.

Custom Replacement Tokens

You can add custom replacement tokens to WarmuP by adding them to the configuration. You can also run a command to add them to the configuration from the command line. WarmuP will also perform file/folder and text replacement for these values like it does __NAME__

 `warmup addTextReplacement findName replacementName`  

i.e. warmup addTextReplacement __COMPANY__ "Somewheres, Intl"

Add New Templates to the Template Folder (Win Vista+)

WarmuP uses symbolic links to add new templates to the template folder and will actually create the template folder in the correct location for the first template you add if it doesn't exist. This allows you to keep your templates in disparate locations and still take advantage of WarmuP from a central usage location.

 `warmup addTemplateFolder templateName "fullPath"`

i.e. warmup addTemplateFolder mvctemplate "c:\code\somefolder\somerepository\mvctemplate"

Get WarmuP

Gems

If you have Ruby 1.8.6+ (and Gems 1.3.7+) installed, you can get the current release of WarmuP to your machine quickly!

  1. Type 'gem install warmup'
  2. Then from anywhere you can type 'warmup '

Chocolatey

If you have Chocolatey installed, you can get the current release of WarmuP to your machine quickly!

  1. Type 'cinst warmup'
  2. Then from anywhere you can type 'warmup '

Also available through NuGet - WarmuP

Build Server

To get the latest build, go to the Chuck Norris project on http://teamcity.codebetter.com. Login as guest.

Source

This is the best way to get to the bleeding edge of what we are doing.

  1. Clone the source down to your machine.
    git clone git://github.com/chucknorris/warmup.git
  2. Run build.bat. NOTE: You must have git on the path (open a regular command line and type git).
  3. WarmuP will be located in code_drop\warmup.

REQUIREMENTS

  • .NET Framework 4.0