Configuring Client Behaviour
- Changelogic
- Client Configuration
If you use Changelogic version 1.x, please follow the link: Client Configuration V-1.x
You can configure behaviour of Changelogic script from two files, placed in your project repository's top level:
- changelogic-project.properties – project-wide settings
- changelogic-personal.properties – your personal settings
You can override project-wide settings in your personal settings file.
The general format and encoding of property files is described in Java API.
Configuring changelogic-project.properties
The project-wide settings file should be stored in VCS in the repository directory of your project. The settings preset in this file apply to every project member, except those who have not overridden the settings in their private settings file.
The following settings are usually stored in project-wide settings file:
| Property | Required? | Explanation | Example |
|---|---|---|---|
| cl.rooturl | Yes | The base URL for the changelogic installation. | cl.rooturl= http://changelogic.example.com |
| cl.commit.messagePrefix | No | The string to be prepended to each commit message. | cl.commit.messagePrefix= Please enter log. |
| cl.checkout.complete | No | Boolean value indicating if uneditable modules should be checked out in addition to editable modules. Defaults to false. | cl.checkout.complete= false |
| cl.test.reportFile | No | The name of the test reports file. If missing, the test report will not be uploaded. | cl.test.reportFile=test |
| cl.integration.pauseMessage | No | The message to display after each merge operation during integration. If missing, there will be no pause after merge. | cl.integration.pauseMessage=Please check for possible merging conflicts. |
| cl.update.pauseMessage | No | The message to display after each merge operation during base update. If missing, there will be no pause after merge. | cl.update.pauseMessage=Please check for possible merging conflicts. |
| cl.build.prepareTarget | No | Name of the target to be executed (in current working directory) to prepare integration/base update directory after merging has been performed. The target will be called in build file residing in working directory, and the integration directory will be passed to it in property ${cl.targetDir}. | cl.build.prepareTarget= prepare_integration |
| cl.integration.buildTargets | No | A comma-separated list of targets to be executed to verify integration results. | cl.integration.buildTargets=clean,compile,test |
| cl.update.buildTargets | No | A comma-separated list of targets to be executed to verify base update results. | cl.update.buildTargets=clean,compile,test |
| cl.version.propertyFile | When integrating | The name of the properties file to be generated | cl.version.propertyFile= version.properties |
| cl.version.properties.prefix | No | The string to be prepended to the names of stage, milestone, submilestone and version properties. | cl.version.properties.prefix=myproject.version |
| cl.version.properties.stage | No | The name of the stage property. | cl.version.properties.stage=functionalityStage |
| cl.version.properties.milestone | No | The name of the milestone property. | cl.version.properties.milestone= productionReleaseCycle |
| cl.version.properties.submilestone | No | The name of the submilestone property. | cl.version.properties.submilestone=testReleaseCycle |
| cl.version.properties.version | No | The name of the version property. | cl.version.properties.version=version |
| cl.version.maven.propertyName | No | The name of the property under which to store the current version number. If missing, the project.properties file will not be updated. | cl.version.mavenProperty=currentVersion |
The integration steps are executed in the copy of build script that resides in the integration directory; preparation target is executed in current directory. When executing the preparation target, the location of current integration directory is passed along in property “cl.targetDir”.
Configuring changelogic-personal.properties
The personal settings file should be kept private, i.e. you should not submit it to VCS. You can download a sample file from the “Supporting Files” page of Changelogic (accessible through the menu that opens upon clicking on your name in the upper right corner).
The following settings are usually stored in personal settings file rather than project-wide settings file:
| Property | Required? | Explanation | Example |
|---|---|---|---|
| cl.user | Yes | Your Changelogic username | cl.user=anna |
| cl.auth-token | Yes | Your CL authentication token for the project you're currently working on. | cl.auth-token=2037d3220fe392a23cc2db332fd871bf |
| cl.vcs.type | No | The type of the VCS to use, either “CVS” or “SVN”. Defaults to CVS. | cl.vcs.type=CVS |
| cl.vcs.repository | When using Subversion | The VCS specific repository address. This option is recommended to be left unset when using CVS. | cl.vcs.repository=svn://svn.example.com/var/svn |
| cl.fs.checkoutDir | When integrating or updating base version | The name of the directory where to perform integrations and base updates. | cl.fs.checkoutDir=/tmp/integration |