Compass Version1.1

TOC

Source-Control Administration

The Source-Control Administration section on the Compass Administration page allows administrators to set up source-control servers bindings. A source-control server binding is how Compass knows when to execute a build plan every time a repository changes. Once a source-control server binding is set up, then a build can be scheduled as a 'Revision' build, executing with every change to the repository. Builds plans can be created and scheduled without specifying a source-control server binding, but only to occur at regular intervals; if you want builds to be triggered by changes to the repository, then a source-control server binding must be added.

The Source-Control Administration section has a table of each existing source-control server bindings and buttons for creating and deleting source-control servers. The secton looks like this:

As of Compass Version 1.1, there are three supported repository tools that Compass can create a revision trigger for: subversion, CVS and perforce. Each of the three types of bindings is set up differently, below there is a section for each tool followed by a final section on using the bindings in the build editor to schedule two different types of builds.

Subversion

To set up a subversion source-control binding first click the 'Create New Server' button and then select 'SVN' from the 'Server Type' drop down. After doing this, the 'Add Source-Control Server' dialog looks like this:

The 'Server Name' and 'Server URL' fields are required, and if the subversion repository requires authentication then the authentication checkbox should be clicked and the subversion server and username should be entered. Below is a table describing each of the fields in this dialog.

Source-Control Server Parameter	Description
Server Name	The Server Name parameter is any descriptive name you want to give the server. It is used only internally to Compass to identify the source-control server binding.
Server URL	The Server URL is the URL that would be specified on the command line to interact with the repository. This can be any subversion supported repository URL such as http://hostname.com/repos or svn+ssh:// This e-mail address is being protected from spambots. You need JavaScript enabled to view it /repos.
Username	If you are setting up a source-control binding that requires authentication then you must first check the checkbox for 'Authentication'. Then, use the Username parameter to specify the user that will access the repository. If you are using the svn+ssh protocol then it is important to set up ssh keys. See the section for Setting Up SSH Keys for details on this process if you don't already know how to set up ssh keys.
Password	The password must be the password that accompanies the user for authentication with the subversion server.

Once a source-control server binding is set up, click the 'Submit' Button. Compass will verify that a connection can be made to the repository server before adding the server binding to the list of existing servers. If Compass fails to connect, a message will be displayed with an explination why the server was not added. In some cases, more details of the failure may be availabe in the compass server log.

Perforce

To set up a perforce source-control binding first click the 'Create New Server' button and then select 'Perforce' from the 'Server Type' drop down. After doing this, the 'Add Source-Control Server' dialog looks like this:

For a perforce source-control server binding, Compass requires the first four parameters in the above dialog. If the perforcerepository requires authentication then the authentication checkbox should be clicked and the password for the given username should be entered. Below is a table describing each of the fields in this dialog.

Source-Control Server Parameter	Description
Server Name	The Server Name parameter is any descriptive name you want to give the server. It is used only internally to Compass to identify the source-control server binding.
Server URL	The Server URL is the URL that would be specified on the command line to interact with the repository. This is usually the perforce server name and default port, ie: p4server:1666.
Username	The Username parameter specifies the perforce user which is used to interact with the server. This is the user that the client workspace belongs to.
Workspace	The Workspace parameter specifies the client workspace to use when interacting with the perforce server.
Password	The password must be the password that accompanies the user for authentication with the subversion server.

CVS

To set up a CVS source-control binding first click the 'Create New Server' button and then select 'CVS' from the 'Server Type' drop down. After doing this, the 'Add Source-Control Server' dialog looks like this:

Source-Control Server Parameter	Description
Server Name	The Server Name parameter is any descriptive name you want to give the server. It is used only internally to Compass to identify the source-control server binding.
Server URL	The Server URL is the URL that would be specified on the command line to interact with the repository. This can be any fully qualified CVS repository URL such as :pserver: This e-mail address is being protected from spambots. You need JavaScript enabled to view it
Username	If you are setting up a source-control binding that requires authentication then you must first check the checkbox for 'Authentication'. Then, use the Username parameter to specify the user that will access the repository.
Password	The password must be the password that accompanies the user for authentication with the subversion server.

Using Source-Control Bindings

Once a source-control server binding is set configured on the 'Add Source-Control Server' , click the 'Submit' Button. Compass will verify that a connection can be made to the repository server before adding the server binding to the list of existing servers. If Compass fails to connect, a message will be displayed with an explination why the server was not added. In some cases, more details of the failure may be availabe in the compass server log.

When the source-control binding is successfully added it will appear in the list of available source-control servers. Adding this server binding does nothing by itself, it only makes it available when scheduling a build. Using the server binding is as simple as scheduling a build; here are the steps to schedule a build plan to execute when a repository change occurs:

Go to the project administration page by clicking on the project from the drop down project menu in the main menu.
Click on the edit/schedule button for the build plan you want to schedule in the 'Build Plans' table
At the bottom of the page, click the 'Schedule Build' button.
Click on the 'Revision' Tab
Select the source-control server binding for the server you want to run the build plan on
Optionally add a subdirectory or module you want to watch
Click 'OK'

Now, the build plan you scheduled will be executed on the repository you selected every time the repository changes. For information on setting up a build plan that can execute at a regular interval or when a repository changes see the Build Plan documentation in the next chapter.