Difference between revisions of "ART developers manual"
(→Creating new .xar packages: added repo.xml.tmpl) |
(→Creating new .xar packages) |
||
Line 11: | Line 11: | ||
These files can be copied from an existing directory and adapted to this package. | These files can be copied from an existing directory and adapted to this package. | ||
− | When building .xar packages, a expath-pkg.xml is generated from the .tmpl and build.xml. In subversion there should be a git:ignore so that locally generated expath-pkg.xml | + | When building .xar packages, a expath-pkg.xml and repo.xml is generated from the .tmpl and build.xml. In subversion there should be a git:ignore so that locally generated expath-pkg.xml and repo.xml are not included in subversion code. |
For examples, see: https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/art/ | For examples, see: https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/art/ |
Revision as of 16:11, 19 January 2017
Contents
Creating new .xar packages
ART-DECOR software is deployed through eXist-db .xar packages with the eXist-db package manager. In order to create these packages, the following files should be present in a subversion software repository:
- build.xml: contains meta information on the package, and the version number (in major.minor.build form). For packages containing software the minor number is:
- even for stable releases
- uneven for development (trunk) releases
- expath-pkg.xml.tmpl: a generic template that should normally not be edited
- icon.png: the icon to display in the package manager when installing packages
- pre-install.xql: pre-installation procedure. This is usually package-specific.
- post-install.xql: post-installation procedure. This is usually package-specific and can contain permission settings for collections and files.
- repo.xml.tmpl: information to display in the package manager for this package. This is a generic template that should normally not be edited.
These files can be copied from an existing directory and adapted to this package.
When building .xar packages, a expath-pkg.xml and repo.xml is generated from the .tmpl and build.xml. In subversion there should be a git:ignore so that locally generated expath-pkg.xml and repo.xml are not included in subversion code.
For examples, see: https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/art/
For more information on building xar's, see: http://exist-db.org/exist/apps/doc/repo.xml
Creating a new version of an existing package
- Commmit your software code, include an (English) subversion comment that describes your changes.
- build.xml: increment the build number:
Example:
<property name="project.version" value="0.989.32"/>
- commit the build.xml to the subversion repository
If the project.version is incremented, this can act as a trigger in the package manager to install this new version of the package.
ART-DECOR repositories
The ART-DECOR repositories are updated daily to include the nightly .xar builds. Locations for the repositories are documented in the installation manual, see Download/software.
ART-DECOR testscenario's
The following testscenario's can be used to test ART-DECOR software: