Configuring Build Script Behaviour
- Changelogic
- Client Configuration V1x
You can configure behaviour of Changelogic script from two files, placed in your project repository's top level:
- devweb-project.properties – project-wide settings
- devweb-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 devweb-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 |
|---|---|---|---|
| devweb.rooturl | Yes | The URL of your Changelogic server. The “index.php” should not be included in the URL. | devweb.rooturl= http://changelogic.example.com |
| devweb.tmpdir | Yes | The temporary directory to use for storing process state and last log files. NOTE: On Windows systems, use single forward slashes «/» or double backslashes "\\" as directory separators. | devweb.tmpdir=changelogic.tmp |
| devweb.version.properties.file | When integrating | Name of the property file to save version number into | devweb.version.properties.file= version.properties |
| devweb.version.properties.prefix | Yes | Prefix of the properties that store parts of version number | devweb.version.properties. prefix=myproject.version |
| devweb.version.properties.names.stage | No | Suffix for the property that stores first part of version number, the functionality stage number. If not specified, default value “stage” will be used. | devweb.version.properties. names.stage=functionalityStage |
| devweb.version.properties.names.milestone | No | Suffix for the property that stores second part of version number, the production release cycle number. If not specified, default value “milestone” will be used. | devweb.version.properties. names.milestone= productionReleaseCycle |
| devweb.version.properties.names.submilestone | No | Suffix for the property that stores third part of version number, the test release cycle number. If not specified, default value “submilestone” will be used. | devweb.version.properties.names. submilestone=testReleaseCycle |
| devweb.version.properties.names.version | No | Suffix for the property that stores fourth part of version number, the number of version within test release cycle. If not specified, default value “version” will be used. | devweb.version.properties. names.version=version |
| devweb.integration.buildfile | No | Ant build script containing targets to run during integration. If not specified, default value “build.xml” is assumed. | devweb.integration. buildfile=build.xml |
| devweb.integration.prepare.target | No | Ant target to run (in script specified by devweb.integration.buildfile) after mainline has been checked out into integration directory and the change has been merged. If not specified, no target is run. | devweb.integration. prepare.target=prepare_integration |
| devweb.integration.prepare.stop.message | No | Message to display when stopping after merge during integration. If not specified, the script will not stop after merge. | devweb.integration .prepare.stop.message=Please check for possible merging conflicts |
| devweb.integration.target0 devweb.integration.target1 devweb.integration.target2 ... | No | Targets to run (in script specified by devweb.integration.buildfile) during integration – the integration steps. If not specified, one target “build_all” is assumed. | devweb.integration.target0=compile devweb.integration.target1=deploy devweb.integration.target2=test |
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 “devweb.integration.dir”.
Configuring devweb-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 |
|---|---|---|---|
| devweb.user | Yes | Your Changelogic username | devweb.user=anna |
| devweb.auth-token | Yes | Authentication code for the environment you are using | devweb.auth-token=2037d3220fe392a23cc2db332fd871bf |
| devweb.integration.dir | When integrating or updating base version | The directory to use for performing integrations and base version updates. You should have enough room for several checkouts of the project. NOTE: On Windows systems, use single forward slashes «/» or double backslashes "\\" as directory separators. | devweb.integration.dir=c:/temp/myproject-integration |
| devweb.project.cvsroot | No | The CVSROOT to use for accessing CVS. If not specified, content of file CVS/Root is used; if such file is not found, value of environment variable “CVSROOT” is used. This property is deprecated and should not be used. | devweb.project.cvsroot=:pserver: :/var/cvs |
| devweb.logging.disabled | No | If set to “yes”, script runtime log is not stored in temporary directory specified by devweb.tmpdir | devweb.logging.disabled=yes |
| devweb.cvscheck.disabled | No | If set to “yes”, your local VCS metainfo files will not be validated before performing VCS operations | devweb.cvscheck.disabled=yes |