mozzy11/openmrs-sdk

OpenMRS SDK is a toolset which facilitates OpenMRS development

It is a repository of OpenMRS Software Development Kit (SDK).

For more details visit the project page.

Requirements

• Maven 3.x

Installation

In order to install the latest version of the sdk run:

mvn org.openmrs.maven.plugins:openmrs-sdk-maven-plugin:setup-sdk

Usage

All commands can be run with mvn openmrs-sdk:<command>.

Run mvn openmrs-sdk:help for the list of supported commands.

Development

To build the plugin run:

mvn clean install

To run a SNAPSHOT version of SDK, you need to specify groupId:artifactId:version for all SDK commands, e.g.

mvn org.openmrs.maven.plugins:openmrs-sdk-maven-plugin:2.1.3-SNAPSHOT:setup-platform

You can also debug commands by creating maven run configurations for the SNAPSHOT version in your IDE and starting them in the debug mode.

Releasing

Before publishing a new release, go to JIRA at https://issues.openmrs.org/plugins/servlet/project-config/SDK/versions and add a next development version. Next move the version you have just added up or down to preseve the ordering. Finally click the gear icon next to the version you want to release and select the Release link. If there are any issues, which are not yet closed for the release, you should see a prompt asking you what to do with them. If the issues have already been committed, close them. Otherwise, move the issues to the next development version.

Next create a new tag named in the following format: release.version_new.dev.version-SNAPSHOT e.g. 3.1.3_3.1.4-SNAPSHOT (the underscore separates release and development versions).

A new Travis-CI build will be triggered, which will create a new tag named after the release version and set a new development version in the master branch.

The tag will be then built and deployed to Bintray. You will have to sign-in and sync with Maven Central.

Finally point the previosly created release in GitHub to the new release version tag.

Usage statistics

OpenMRS SDK gathers anonymous usage statistics, which are shared on request. Please contact the project lead to request read-only access.