CFEclipse for Configuration Management
In every company I've worked, configuration management has always caused huge problems. Through the "magic" of file template snippets in CFEclipse I have put together a deployment document for our company which reduces the number of times someone has to ask, "which server is it on", "when did this change happen", "why did we make that change".
Even better, CFEclipse allows you to store your snippets in a networked location so we have ours in a common template folder.
First
I'm going to give you the snippet we use and then explain how to set it
up. It should also be noted that similar magic can be worked in
Dreamweaver but I'll leave that post to someone who actually likes that
IDE :-)
---BEGIN SNIPPET ------------
Deployment Request Document $${CURRENTFILE}
For: $${Client Name}
Date: $${MONTHNUMBER}.$${DAYOFMONTH}.$${YEAR2DIGIT}"
Purpose: $${Purpose of the deployment}
Bug tracking case #: $${Sales force case number}
Author: $${CURRENTUSER}
Files to deploy to $${Live destination server}.
$/WWW/appraisal/qry_complist_search.cfm
$/WWW/appraisal/reports/dsp_reports_turnardclient.cfm
Scripts to execute on $${Database server name}:
$/db/sp_search_comps_vii.sql
SQL Permissions to run after scripts execute:
GRANT EXECUTE ON dbo.sp_serach_comps_vii.sql TO vn_admin_role
----- END SNIPPET -----------
To create a file template snippet in CFEclipse:
- If it isn't already open go to Window > Show View > Snip Tree View
- Go to Window > Preferences > CFEclipse > File Paths and check the path. This is where you can repoint CFEclipse to a network drive of templates if you want.
- Save your changes if you made any and close out of Preferences
- Find the snip tree view in your perspective and click the big plus symbol "+".
- Give your snippet a name, optionally some trigger text, a description of the snippet and then the start and end block.
- If there are variables in your file that change per day, file, user etc you can create your own variable using the format $${param name} e.g. $${Purpose of the file} or you can use some auto text ones. For an excellent list, consult Spike's documentation.
- Check the box "Use this snippet as a file template"
- Set the extension and hit OK to save it.
To use your file template snippet, you have two choices.
Double click the snippet to insert it at the cursor or if you want to
create the file in your configuration management directory:
- Right click on the directory you wish to store your new file
- Select New > Other
- Select CFEclipse > File From Template and hit next.
- If the path is inaccurate, hit Browse and set it.
- Set the filename
- Your template should be listed in the panel. Select it and click finish
- Any variables you created will be listed so you can enter them.
So there you have it. We use VSS and the Eclipse VSS plugin for our development so I can check these config files into VSS directly.