Releasing a version of your bundle

When you create a Digital Service application project using the Maven archetype, your application is created with bundle version 1.0-SNAPSHOT and you do the development work with same version. You may need to release this bundle and start the development work on a new version. For example, you want users to start using your application version 1.0 and you need to start with the development of your application 1.1. 

To release an initial version

 The following image shows the process to release the initial version of an application:T

Exporting bundle

Ensure that your definitions are up to date and run the following command to export your bundle:

projects\my-proj> mvn generate-resources -Pexport

Stopping bundle version 1.0 development

If you are using any sources in Source Control, branch or label your sources. Ensure that you do not modify definitions for version 1.0. Remove the bundle from your BMC Helix Platform development instance, using the following command:

projects\my-proj> mvn com.bmc.arsys:rx-sdk-maven-plugin:undeploy -N

Note that this is a required step.

Changing bundle to a released version

<build>
    <plugins>
        <plugin>
            .
            .
            <executions>
                <execution>
                    <id>update-def-file</id>
                    <phase>generate-sources</phase>
                    <goals>
                        <goal>update-def-file</goal>
                    </goals>
                </execution>              
                <execution>
                    <id>add-manifest</id>
                    <phase>generate-resources</phase>
                    <goals>
                        <goal>add-manifest</goal>
                    </goals>
                </execution>
                .
                .
                .
            </executions>
        </plugin>

Update your POM files using the following command:

projects\my-proj> mvn versions:set -DnewVersion=1.0.0

After you run the command, you receive a success message. The following snippet illustrates a sample message:

[INFO] Updating project com.myco:my-proj
[INFO] from version 1.0-SNAPSHOT to 1.0.0
expression: rx-sdk.groupId no value
expression: rx-sdk.groupId no value
expression: rx-sdk.groupId no value
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] my-proj-all ....................................... SUCCESS [ 54.270 s]
[INFO] My Project ........................................ SKIPPED
[INFO] my-proj-package ................................... SKIPPED
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

The version is created in the following format:

<major version>.<minor version>.<incremental version>-<qualifier>


For example, 17.11.0, 17.11.0-SNAPSHOT, 1.0-SNAPSHOT, 1.0.0.RELEASE.

Packaging

Ensure that all the sources, and the renamed definition files, are correctly packaged together in the deployment zip file. Run the following command:

projects\my-proj> mvn clean install

The compiled deployment package is present at projects\my-proj\package\target\com.myco.my-proj-1.0.zip. The com.myco.my-proj-1.0.zip file contains the following files:

• db
  • record
    • <record-definition-name1>.def
    • <record-definition-name2>.def
    • <record-definition-name3>.def
    • <record-definition-name3>.options
    • <record-definition-name3>.data
    • <record-definition-name3>.delete
  • process
    • <process-definition-name1>.def
    • <process-definition-name2>.def
  • rule
    • <rule-definition-name>.def
  • association
  • view
    • <view-definition-name>.def
  • named-list
    • <named-list-definition-name1>.def
    • <named-list-definition-name2>.def
  • localized-string
    • <localized-strings.def>

  • configuration.data

  • role.data

• code <jar file>
• manifest file

Releasing

To provide the bundle to QA for black-box or integration testing, or to a pre-production shared system, make the package file projects\my-proj\package\target\com.myco.mypackage.my-proj-1.0.zip available to administrators for the next phase of delivery. Now you are done with bundle version 1.0.

Guidelines on creating a new version of an application

When you upgrade your application to a new version, ensure that the modifications made to the new version of your application do not affect the functionalities of the existing application version. The following table lists the guidelines to follow:

To release a new version

Perform the following steps to release a new version of your application:

1. Update your POM files using the following command:

   projects\my-proj> mvn versions:set -DnewVersion=1.1.0-SNAPSHOT

   The new version is created in the following format:

   <major version>.<minor version>.<incremental version>-<qualifier>


   For example, 17.11.0, 17.11.0-SNAPSHOT, 1.0-SNAPSHOT, 1.0.0.RELEASE. 

   Note

   BMC Helix Platform uses <major version>, <minor version>, and <incremental version> parameters for versioning an application.

   • If you change the <majorversion> or <minor version> parameter in an application version, a new version of your application is created. 
   • If you change the <incremental version> parameter in an application version, the existing version of your application is updated.

2. Deploy the new version by using the following command:

   projects\my-proj> mvn clean install -Pdeploy

By default only two versions of an application can be deployed on a system. If you deploy a third version, the following error is generated:

9164: Maximum number of allowed versions exceeded.

BMC SaaS Operations must undeploy the oldest version. If the latest version is undeployed, all versions of the application are undeployed from the system. 

Related topic

Deploying the custom code-based applications to development environments