Build

The build command provides the ability to build either a complete or incremental deployment, which can then be deployed to a target JADE database.

This command depends on opening a repository to build the deployment from.

Revision

The --revision option may be used to specify a revision string for the deployment. By default, HEAD is used to refer to the current branch/commit.

This may refer to a single commit, in which case a complete deployment will be built.

jadegit build --revision <latest> ...

This may also refer to a range of commits, in which case an incremental deployment will be built, including any commands required to rename, delete, move classes, and any other special operations needed to upgrade schemas from the prior version.

jadegit build --revision <previous>..<latest> ...

Registry

The --registry option is used to supply the registry file extracted from the target database. For a fresh database, the registry data extracted is empty, so a complete deployment would be built, otherwise an incremental deployment is built based on the prior version info stored within the registry.

jadegit build --registry <path> ...

This may be used in combination with the --revision option to specify the latest version to deploy (HEAD by default), but not a range of commits as the previous version info from the registry is used.

jadegit build --revision <latest> --registry <path> ...

The --init-registry flag may be used to build a deployment which initializes the registry. This could be used for preparing initial deployments for new databases where the registry will be used to track version info going forward (without needing to extract/use the registry option above).

jadegit build --init-registry ...

This may be used in combination with the --revision option to specify either the latest version to deploy (HEAD by default), or a range of commits to setup the registry in a target database for which the previous version has been stored separately, for which the registry will be used going forward.

jadegit build --revision <previous>..<latest> --init-registry ...

Formats

The format of the deployment to build is specified via a subcommand.

Multiple Schema File Extract

The mul subcommand provides the ability to build a standard multiple schema file extract.

The destination output directory is required, and an optional name may be specified which defines the name of the *.mul file created.

jadegit build --revision v0.1..v0.2 mul --name "Update" C:\temp\build

While registry options can be used for building, this format does not generate the file needed to update the registry in the target database. Support for this may be added in future, however executing the registry load command would still need to be handled after loading the schema files.

Due to JADE limitations, this format does not support the use of command files (needed to handle renames and other special operations).

Scripted

The pwsh subcommand provides the ability to build a scripted deployment using PowerShell.

Use the following command to run the deployment from the output directory (copying to host of the target database beforehand if required).

.\deploy.ps1 -bin "C:\Jade\bin" -path "C:\Jade\system" -ini "C:\Jade\jade.ini"

JARI

The jari subcommand provides the ability to build a JADE Authorised Release Instruction (JARI), for deployment via JSM (JADECare Systems Manager) to managed environments.

The --environment option is required to specify the JSM environment name.

The --description option is required to specify a short description for the deployment.

The --developer option is used to specify the JSM username for the developer to be notified, which is also used for authorisation by JSM (hence this is currently required).

The --working-directory option is currently needed to define what directory the deployment files will be copied to & submitted to JSM from.

The --defeat-backups, --defeat-pre-backup or --defeat-post-backup options may be used to suppress backups JSM may otherwise take before/after deployment.

Generic

The xml subcommand provides the ability to build a generic deployment, with an XML instruction file intended to be transformed/processed as needed by third parties to handle deploying/publishing updates in a customized manner.

This format doesn't currently support the use of registry files. The structure of the XML instruction file will likely change when support is implemented in future.