{"type":"doc","content":[{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"2"},"_parentId":{"value":"25468239"}},"macroMetadata":{"macroId":{"value":"c7988a13-7a11-4b82-9a34-92487a5238f2"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Changes in the repository","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"1) Change the SCM tag of your pom file to use SSL.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n scm:git:git@github.com:openmrs/openmrs-module-allergyapi.git\n scm:git:git@github.com:openmrs/openmrs-module-allergyapi.git\n https://github.com/openmrs/openmrs-module-allergyapi.git\n","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"2) Make sure to set the correct distributionManagement for your project:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n \n openmrs-repo-modules\n OpenMRS Nexus Modules\n http://mavenrepo.openmrs.org/nexus/content/repositories/modules\n \n \n openmrs-repo-snapshots\n OpenMRS Nexus Snapshots\n http://mavenrepo.openmrs.org/nexus/content/repositories/snapshots\n \n","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"3) Check the release plugin configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"It cannot have a 'pushChanges=false', and the tag name format should be set to the OpenMRS standard.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\t\t\n maven-release-plugin\n 2.4.2\n \n \n\t\t\t\tfalse\n\t\t\t\t \n\t\t\t\t@{project.version}\n \n \n","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"4) If you want to use the version of modules and dependencies defined in the refapp distro pom:","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.1) Add to your parent pom:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\t\n org.openmrs.distro\n referenceapplication\n 2.1-SNAPSHOT\n \n \n \n \n \n ${distro.groupId}\n ${distro.artifactId}\n ${distro.version}\n pom\n import\n \n \n \n...\n\t\n\t\t\n maven-release-plugin\n 2.4.2\n \n \n true\n \n \n ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.2) Delete all the other dependencies in DependencyManagement already defined.","type":"text"}]},{"type":"paragraph","content":[{"text":"For each dependency of your omod and api that belongs to the distro, make sure it's provided or test scoped.","type":"text"}]},{"type":"paragraph","content":[{"text":"Keep the properties used to generate the config.xml file for your omod.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.3) Confirm your plugin still ships the right dependencies","type":"text"}]},{"type":"paragraph","content":[{"text":"Generate a dependency tree of both versions (before the changes and after), and make sure the scope and the dependencies are correct. If it changed, try to identify what caused it.","type":"text"}]},{"type":"paragraph","content":[{"text":"Do a ","type":"text"},{"text":"mvn package","type":"text","marks":[{"type":"em"}]},{"text":" and confirm that inside ","type":"text"},{"text":"omod/target/your module-1.0-SNAPSHOT/lib/","type":"text","marks":[{"type":"em"}]},{"text":" it's only shipping what it should include. If not, find the dependency added and change its scope to provided or test.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.4) Make sure to update the register of modules using it.","type":"text"}]},{"type":"paragraph","content":[{"text":"(temporarily it's in ","type":"text"},{"text":"openmrs-contrib-bamboo repo","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-contrib-bamboo/blob/master/list-repos-using-refapp-import.txt"}}]},{"text":")","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Creating a new build with a release stage:","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"1) Clone the ","type":"text"},{"text":"Release test module","type":"text","marks":[{"type":"link","attrs":{"href":"https://ci.openmrs.org/chain/admin/config/defaultStages.action?buildKey=RELEASE-RTM"}},{"type":"em"}]},{"text":" build","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"wide"},"content":[{"type":"media","attrs":{"__fileSize":221712,"__fileMimeType":"image/png","width":1280,"id":"b9779836-8332-4206-bb4b-3ebc09a1a20a","collection":"contentId-25468239","type":"file","__fileName":"Screen Shot 2014-09-16 at 7.03.34 pm.png","height":615}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"2) Change the plan configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"When selecting the plan, Actions/Configure plan. Make sure to click in the plan level again in the configuration mode.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"2.1) Plan details tab","type":"text"}]},{"type":"paragraph","content":[{"text":"Add a link to the ","type":"text"},{"text":"Releasing a Module from Bamboo","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"linkType":"page","contentTitle":"Releasing a Module from Bamboo"},"href":"https://openmrs.atlassian.net/wiki/spaces/Archives/pages/25494635"}}]},{"text":" page in the plan config. For example, 'More details of the release in ","type":"text"},{"text":"https://openmrs.atlassian.net/wiki/x/Mi9YAQ","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/x/Mi9YAQ"}}]},{"text":"'","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"2.2) Repositories tab, 'Git' repository","type":"text"}]},{"type":"paragraph","content":[{"text":"Change it to point to your repository.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"2.3) Variables tab","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Delete ","type":"text"},{"text":"refapp.distro.dev.branch","type":"text","marks":[{"type":"em"}]},{"text":" variable","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Change ","type":"text"},{"text":"maven.release.version","type":"text","marks":[{"type":"em"}]},{"text":" to the next version that should be released (e.g, if your pom is 1.0-SNAPSHOT, this variable should be 1.0)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Change ","type":"text"},{"text":"refapp.distro.property","type":"text","marks":[{"type":"em"}]},{"text":" to the property of this module in the ","type":"text"},{"text":"refapp distro pom file","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-distro-referenceapplication/blob/master/pom.xml"}}]},{"text":". If it's not part of the distro, delete this variable.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"2.4.) Update Java version","type":"text"}]},{"type":"paragraph","content":[{"text":"Make sure you are using the correct java version in both the first stage and the release stage (controlled by the JAVA_HOME variable):","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":56.0},"content":[{"type":"media","attrs":{"__fileSize":115835,"__fileMimeType":"image/png","width":1218,"id":"9f1dfeb2-85ce-4452-93a5-fe12142fa909","collection":"contentId-25468239","type":"file","__fileName":"Screen Shot 2017-04-26 at 1.26.50 PM.png","height":792}}]},{"type":"mediaSingle","attrs":{"layout":"wide"},"content":[{"type":"media","attrs":{"__fileSize":274494,"__fileMimeType":"image/png","width":1280,"id":"8185cd28-d176-499c-bfbd-de87fc6a2900","collection":"contentId-25468239","type":"file","__fileName":"Screen Shot 2017-04-26 at 1.27.20 PM.png","height":437}}]},{"type":"paragraph","content":[{"text":"To run in JDK 7, you can just remove the JAVA_HOME variable in the release prepare/perform task (or use ","type":"text"},{"text":"JAVA_HOME=${bamboo.capability.system.jdk.openjdk-7-jdk}","type":"text","marks":[{"type":"em"}]},{"text":").","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"2.5) Dependencies tab","type":"text"}]},{"type":"paragraph","content":[{"text":"If your build is going to trigger other plans, make sure to add to its dependencies. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"2.6) Handle Test cases during the build","type":"text"}]},{"type":"paragraph","content":[{"text":"If your module doesn't have any test cases, then Goto Configuration → Tasks → Maven 3 X. Then clear the selection of the \"","type":"text"},{"text":"The build will produce test results\". Otherwise you might get the build failures. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]}]},{"type":"mediaSingle","attrs":{"layout":"full-width"},"content":[{"type":"media","attrs":{"__fileSize":100866,"__fileMimeType":"image/png","width":1280,"id":"1b41df9b-8ec4-4555-8682-be00eee7b890","collection":"contentId-25468239","type":"file","__fileName":"image2018-8-13_16-45-51.png","height":444}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"2.7) Refapp distro release tasks","type":"text"}]},{"type":"paragraph","content":[{"text":"If your module is ","type":"text"},{"text":"not","type":"text","marks":[{"type":"strong"}]},{"text":" part of the refapp distro, make sure to delete the relevant tasks in the ","type":"text"},{"text":"'Release to maven","type":"text","marks":[{"type":"link","attrs":{"href":"https://ci.openmrs.org/build/admin/edit/editBuildTasks.action?buildKey=RELEASE-RTM-JOB1"}}]},{"text":"' job of your build:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Retrieve next snaphot version","type":"text","marks":[{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update distro with the new version","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Creating a manual stage for a build that already exists:","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"1) Add a link to the ","type":"text"},{"text":"Releasing a Module from Bamboo","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"linkType":"page","contentTitle":"Releasing a Module from Bamboo"},"href":"https://openmrs.atlassian.net/wiki/spaces/Archives/pages/25494635"}}]},{"text":" page in the plan config","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, 'More details of the release in ","type":"text"},{"text":"https://openmrs.atlassian.net/wiki/x/Mi9YAQ","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/x/Mi9YAQ"}}]},{"text":"'","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"2) Create the plan variables:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"maven.development.version","type":"text","marks":[{"type":"em"}]},{"text":" - leave it empty. It could be used to override the default value","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"maven.release.version","type":"text","marks":[{"type":"em"}]},{"text":": add the next release version of this module. Check the pom file in doubt. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"refapp.distro.property","type":"text","marks":[{"type":"em"}]},{"text":": only necessary if this module is part of the refapp distro. The maven property in the ","type":"text"},{"text":"refapp distro pom file","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-distro-referenceapplication/blob/master/pom.xml"}}]},{"text":" for this module.","type":"text"}]}]}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-warning","text":":warning:","shortName":":warning:"}},{"text":" If you are using ","type":"text"},{"text":"Release test module","type":"text","marks":[{"type":"link","attrs":{"href":"https://ci.openmrs.org/chain/admin/config/configureChainVariables.action?buildKey=RELEASE-RTM"}}]},{"text":" as a guide, ignore the ","type":"text"},{"text":"refapp.distro.dev.branch","type":"text","marks":[{"type":"em"}]},{"text":" variable. It's there only for testing purposes.","type":"text"}]},{"type":"paragraph"},{"type":"mediaSingle","attrs":{"layout":"wide"},"content":[{"type":"media","attrs":{"__fileSize":328282,"__fileMimeType":"image/png","width":1280,"id":"63a2523b-7c4e-455d-a105-f8abbfdd3a54","collection":"contentId-25494635","type":"file","__fileName":"variables.png","height":464}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"3) In the plan configuration, add 'Release scripts' as the second repository:","type":"text"}]},{"type":"paragraph","content":[{"text":"This repository","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-contrib-bamboo"}}]},{"text":" contains some scripts to execute the release.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"wide"},"content":[{"type":"media","attrs":{"__fileSize":452244,"__fileMimeType":"image/png","width":1280,"id":"7d158ca9-a3cb-4217-8e92-c98e4d985e0b","collection":"contentId-25494635","type":"file","__fileName":"repo.png","height":677}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"4) Remove the polling trigger of the 'Release scripts' repository","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"wide"},"content":[{"type":"media","attrs":{"__fileSize":398350,"__fileMimeType":"image/png","width":1280,"id":"45d33312-9d84-4162-a890-e16b2b244a07","collection":"contentId-25468239","type":"file","__fileName":"trigger.png","height":653}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"5) Create a manual stage for the release:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"wide"},"content":[{"type":"media","attrs":{"__fileSize":394031,"__fileMimeType":"image/png","width":1280,"id":"18111612-432b-4392-b21c-81c2041b0780","collection":"contentId-25468239","type":"file","__fileName":"stage.png","height":756}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"6) Create the job for that stage","type":"text"}]},{"type":"paragraph","content":[{"text":"You can use","type":"text"},{"text":" Release module - Release to maven job","type":"text","marks":[{"type":"link","attrs":{"href":"https://ci.openmrs.org/build/admin/edit/editBuildTasks.action?buildKey=RELEASE-RTM-JOB1"}}]},{"text":" as a reference.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"6.1) Checkout task:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"wide"},"content":[{"type":"media","attrs":{"__fileSize":484618,"__fileMimeType":"image/png","width":1280,"id":"95d58bf6-e77c-4b11-ba3e-c99fc3153b21","collection":"contentId-25468239","type":"file","__fileName":"Screen Shot 2014-09-16 at 3.52.59 pm.png","height":844}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"6.2) Release prepare/perform","type":"text"}]},{"type":"paragraph","content":[{"text":"Execute the release bash script from ","type":"text"},{"text":"https://github.com/openmrs/openmrs-contrib-bamboo","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-contrib-bamboo"}}]}]},{"type":"mediaSingle","attrs":{"layout":"wide"},"content":[{"type":"media","attrs":{"__fileSize":280577,"__fileMimeType":"image/png","width":1280,"id":"d876a5f5-6d4d-4c11-beda-1b4fd21b944f","collection":"contentId-25468239","type":"file","__fileName":"Screen Shot 2014-09-16 at 4.46.39 pm.png","height":759}}]},{"type":"paragraph","content":[{"text":"If your build requires JDK 8, make sure to add ","type":"text"},{"text":"JAVA_HOME=${bamboo.capability.system.jdk.openjdk-8-jdk}","type":"text","marks":[{"type":"em"}]},{"text":" to the environment variables. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"6.3) Retrieve from the pom file what will be the next release","type":"text"}]},{"type":"paragraph","content":[{"text":"Save next version in the plan.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"wide"},"content":[{"type":"media","attrs":{"__fileSize":432034,"__fileMimeType":"image/png","width":1280,"id":"192c75e6-8869-4204-b239-d6728a2d361a","collection":"contentId-25468239","type":"file","__fileName":"Screen Shot 2014-09-16 at 4.43.30 pm.png","height":953}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"6.4) Retrieve the snapshot version to use in the next task","type":"text"}]},{"type":"paragraph","content":[{"text":"Only if this module is part of the refapp distro","type":"text","marks":[{"type":"em"}]}]},{"type":"mediaSingle","attrs":{"layout":"wide"},"content":[{"type":"media","attrs":{"__fileSize":400310,"__fileMimeType":"image/png","width":1280,"id":"06cc20ac-8646-4c76-8b80-14bc2d894eb0","collection":"contentId-25468239","type":"file","__fileName":"Screen Shot 2014-09-16 at 5.14.19 pm.png","height":910}}]},{"type":"paragraph"},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"6.5) Update version in the distro","type":"text"}]},{"type":"paragraph","content":[{"text":"Only if this module is part of the refapp distro","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Execute the distro update bash script from ","type":"text"},{"text":"https://github.com/openmrs/openmrs-contrib-bamboo","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-contrib-bamboo"}}]}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"inline-media-image","parameters":{"width":"800","id":"ba1cd465-2697-434c-8734-d29460a48afd","collection":"contentId-25468239","height":""}}},{"text":" ","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Creating a 'plan branch' to handle builds and releases of ","type":"text"},{"text":"another","type":"text","marks":[{"type":"em"}]},{"text":" branch (than master)","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"paragraph","content":[{"text":"From the build configuration screen, click on the plan branches configuration","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":62.0},"content":[{"type":"media","attrs":{"__fileSize":56558,"__fileMimeType":"image/png","width":502,"id":"b2174b50-a42b-4822-92f3-d0d4ba1b6153","collection":"contentId-25468239","type":"file","__fileName":"image2018-9-9_11-40-56.png","height":294}}]},{"type":"paragraph","content":[{"text":"From there click on 'Create plan branch'","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":73.0},"content":[{"type":"media","attrs":{"__fileSize":23778,"__fileMimeType":"image/png","width":875,"id":"e6998485-e4ff-4fa8-a725-4ee707b71386","collection":"contentId-25468239","type":"file","__fileName":"image2018-9-9_11-44-52.png","height":109}}]},{"type":"paragraph","content":[{"text":"Bamboo will detect all the branches of the repository, pick the other-than-master branch off which you need to build/release:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":47.0},"content":[{"type":"media","attrs":{"__fileSize":39376,"__fileMimeType":"image/png","width":638,"id":"beb07f7d-61f9-43f5-97ba-06a17ac3a2aa","collection":"contentId-25468239","type":"file","__fileName":"image2018-9-9_11-46-29.png","height":494}}]},{"type":"paragraph","content":[{"text":"Before clicking on 'Create', make sure that you enable the branch:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":33.0},"content":[{"type":"media","attrs":{"__fileSize":6498,"__fileMimeType":"image/png","width":231,"id":"bd6e14f4-9192-4542-9dd9-6a5eb80c4f08","collection":"contentId-25468239","type":"file","__fileName":"image2018-9-9_11-48-9.png","height":81}}]},{"type":"paragraph","content":[{"text":"From this point everything works as usual once you have selected which branch to work on:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":68.0},"content":[{"type":"media","attrs":{"__fileSize":36165,"__fileMimeType":"image/png","width":467,"id":"9f95c059-28d3-40b4-9a5e-6bbc32552038","collection":"contentId-25468239","type":"file","__fileName":"image2018-9-9_11-50-16.png","height":167}}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Update documentation","type":"text"}]},{"type":"paragraph","content":[{"text":"Make sure to add your module to ","type":"text"},{"text":"Releasing a New Version of a Module","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"linkType":"page","contentTitle":"Releasing a New Version of a Module"},"href":"https://openmrs.atlassian.net/wiki/spaces/Archives/pages/25466683"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"If you do not have access to bamboo, ask ","type":"text"},{"text":"OpenMRS Help Desk","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/x/-zJIAQ"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Resources","type":"text"}]},{"type":"paragraph","content":[{"text":"Module Release","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"spaceKey":"docs","linkType":"page","contentTitle":"Module Release"},"href":"https://openmrs.atlassian.net/wiki/spaces/docs/pages/25469652"}}]}]}],"version":1}

Browser not supported