Skip to content

RELEASE-JMRI.md

Latest commit

 

History

History
116 lines (71 loc) · 3.82 KB

RELEASE-JMRI.md

File metadata and controls

116 lines (71 loc) · 3.82 KB

How to release OpenLCB to JMRI

Prerequisites

  • You need to have a git checkout of the OpenLCB_Java repository. This may be a fork or you need to have write access to the repository.
  • You need to be able to compile java using the maven build toolchain.
  • You need to have a git checkout of JMRI, presumably from a fork.
  • For the JMRI update you need to have the maven tool installed. (For me maven2 did not work, had to use maven: apt-get install maven)

Release OpenLCB

  1. Update the master branch

    git checkout master

    git pull

  2. Create a new branch for your changes

    git checkout -b bracz-newrelease

  3. Update the minor version number

    Edit the following files and bump the "library" / "package" minor version number:

    • manifest and edit the Package-Version to bump last number
    • src/org/openlcb/Version.java and bump libMod.
    • update the version in the maven 'pom.xml' file by running
mvn versions:set -DnewVersion=0.7.14
  1. verify the build completes
mvn clean verify

and observe that no errors are reported (at least in the VerionTest).

  1. Commit everything and push to github

commit the three files: manifest, Version.java and pom.xml. Push your branch to github and create a pull request. Mark in the commit that you are increasing the version number.

  1. Create a pull request to OpenLCB/master

    Create a new pull request on github targeted at OpenLCB/master. Once the CI builds complete, create merge the pull request.

  2. Create a new release on GitHub

    Navigate to the OpenLCB_Java repository on github. Create a release as described in the github documentation setting the release name and tag to 'release-version' ('release-0.7.14', for example).

    Once the release is created, a github action will run to publish the release to Maven Central.

Update JMRI for new OpenLCB

This process is generally defined by https://github.com/JMRI/JMRI/blob/master/lib/README.md#updates so it's worth to check out if the process changed form what's described below.

  1. Verify the version to update JMRI with is published at http://repo1.maven.org/maven2/org/openlcb/openlcb

  2. Update the master branch of your fork by pulling from upstream

git checkout master

git pull upstream

you may also want to update your github fork of the repository

git push origin

  1. Create a new branch for your changes

git checkout -b openlcb-release-update master

  1. Download the new JAR file into libs

Download the new JAR file into the lib/ subdirectory (replace VERSION with the real version):

curl -o lib/openlcb.jar http://repo1.maven.org/maven2/org/openlcb/openlcb/VERSION/openlcb-VERSION.jar

  1. Update the library dependency version number:

Edit lib/README.md and update the version number for the openlcb.jar library.

Edit pom.xml and update the version number for the openlcb.jar library.

You don't need to edit build.xml, .classpath, nbproject/ide-file-targets.xml and nbproject/project.xml because these do not refer to the file by version number.

  1. It's a good idea to test JMRI with the new library version.

    ant panelpro

    Click around to check a few things related to OpenLCB.

  2. Commit your code, binaries and push to github (to your own fork of the project)

    Example commits: https://github.com/JMRI/JMRI/pull/2463/commits/a361846a13e6dc84cb43d9b81430b2a9a00418c0

  3. Create a pull request for JMRI

    Go to github, open your own fork of the JMRI project, select the branch you created (github will give you a quick link in yellow) and click "create pull request".

  4. Wait for a JMRI project member to approve your pull request.