Overview

Overview -

Forrestbot lets you automate building & deploying websites. There - are implementations to get source from various locations, build it, then - deploy it somewhere. It can notify you afterwards, and it keeps a log of - the build process. Each workstage has multiple implementations; you can - use one or more of each.

Forrestbot lets you automate building and deploying websites. The whole process gets the source docs, builds it, then deploys the site where you want it to go. It can also notify you afterwards, and it keeps a log of the build process. To accomplish these tasks Forrestbot uses four "workstages" (getsrc, build, deploy, notify) that are comprised of "implementations" and have various properties that may be set, depending upon the implementations chosen.

+ Need a better term than comprised of? Trying give a sense of the building blocks used and how they relate to each other.

Using Forrestbot -

Simply execute:

You need to create a customized buildfile directing Forrestbot's work and then simply execute:

forrest -f mybuildfile.xml @@ -46,7 +43,13 @@

Creating a buildfile -

A sample buildfile:

+ + +

Within the new buildfile you need to first set properties needed by the workstages you are going to use and then specify what implementations will be used by each workstage.

+ This seems backwards since the properties are dependent on the implementations - no? + +

This sample buildfile can be used as a base from which to customize your own buildfile. The file starts with the project name and default workstage target, then sets the specific properties we will need to get the source, set up notification and indicate the deploy location. It then specifies which implementations we will use and finishes up with importing the forrestbot.xml file.

+ Is "default workstage target" the correct term for default="main"? <project name="mysampleproject" default="main"> <property name="notify.email.host" value="smtp.myhost.com"/> @@ -74,10 +77,9 @@ -

First, set properties needed by the workstages you are going to use. - Here, we set properties that will be used by notify.email and getsrc.cvs. - Next, specify what implementations will be used by each workstage.

- +

+ Workstages +

It is only necessary to include the specific target implementations in the buildfile if we want to override the default implementations. The following tables show the various workstages and which implementations may be used for each and which is the default.

@@ -135,22 +137,22 @@ name="main" depends="getsrc, build, deploy, notify"/>, create your own implementation of a workstage, or use any other ant tasks to do additional work.

- + How do you create your own implementation? Can you create a different default target than main - how do you override the default?

- -

Many workstages use usernames and passwords. You may want to keep them - out of your project's xml file (especially if you store that file in CVS - or SVN). A nice way to do this is make a simple buildfile (e.g. - my-settings.xml) that just sets those properties (don't include it in - CVS/SVN!). Then in your project buildfile, have <import - file="my-settings.xml"/>.

- +

Workstage Properties

Each workstage implementation is configurable with properties. The following tables describe each property and whether or not you are required to set it in your buildfile.

+ +

Many workstage properties use usernames and passwords. You may want to keep them + out of your project's xml buildfile (especially if you store that file in CVS + or SVN). A nice way to do this is make a simple buildfile (e.g. + my-settings.xml) that just sets those properties (don't include it in + CVS/SVN!). Then in your project buildfile, have <import + file="my-settings.xml"/>.

Misc Properties @@ -364,7 +366,7 @@

Workstage

deploy.local @@ -381,7 +383,7 @@ - @@ -391,7 +393,7 @@

deploy.local.dir

Path to deploy site to. Relative paths will be relative to +

Path to deploy site to - the dir that would be the equivalant of build/site dir. Relative paths will be relative to ${bot.home}

sites/${ant.project.name}

deploy.scp

${user.home}/.ssh/known_hosts must properly recognize the host, so @@ -718,14 +720,15 @@ - +

The workstage buildfiles set up the properties and files so that the main forrest buildfile (forrest.build.xml) will run. After it is run, - other workstages buildfiles can implement reporting, deployment, or other + other workstage buildfiles can implement reporting, deployment, or other post-build activities.

Your buildfile can specify which workstages you want to use, set properties for them, and do any additional pre- and post-processing.

+ Which of these (Your buildfile/workstage buildfile) is the "project buildfile" referred to elsewhere on this page, if any? If it is "Your buildfile" can I also create workstage buildfiles? If so, how?