Skip to content

Latest commit

 

History

History
43 lines (36 loc) · 2.57 KB

Release-Instructions.md

File metadata and controls

43 lines (36 loc) · 2.57 KB
Raw

Release Instructions

Encore does not currently have an automated release system. These release instructions have been created in order to avoid mistakes while making a release.

Instructions

Build the UI app package

  1. Pull the latest encore-matlab-ui repository changes and ensure everything is up-to-date by running: git pull; git submodule foreach --recursive "(git checkout master; git pull)"; git status
  2. Open MATLAB
  3. Change directory to the root encore-matlab-ui submodule directory within the encore-matlab repository
  4. Add the lib and src directory and their child directories to the MATLAB path
  5. Open Encore UI.prj
  6. Click "Refresh dependencies"
  7. Close the project
  8. Edit encoreui.app.App and make sure the version matches the next release version number
  9. Package the app by running: package

Build the toolbox package

  1. Pull the latest encore-matlab repository changes and ensure everything is up-to-date by running: git pull; git submodule foreach --recursive "(git checkout master; git pull)"; git status
  2. Open MATLAB
  3. Change directory to the root encore-matlab directory
  4. Generate the documentation from the wiki by running: site
  5. Replace src/main/resources/docs with target/site
  6. Add the lib and src directory and their child directories to the MATLAB path
  7. Edit encore.app.App and make sure the version matches the next release version number (this should generally be the same number used while building the UI app)
  8. Package the toolbox by running: package

The releasable toolbox (Encore.mltbx) is now under the target directory.

Create a new release on GitHub

  1. Go to https://github.com/Encore-DMS/encore-matlab/releases
  2. Click "Draft a new release"
  3. Enter the tag version as the Encore version number being release (e.g. 2.0.2.1)
  4. Enter the release title in the format "ENCORE_VERSION (MAJOR.MINOR-DEV_STAGE.REV) x64" (e.g. 2.0.2.1 (2.0-rc1) x64). The third position of the full ENCORE_VERSION indicates the DEV_STAGE: 0 = alpha, 1 = beta, 2 = release candidate, 3 = release. The forth position indicates the REV.
  5. Enter the release notes
  6. Attach the Encore.mltbx file
  7. Mark the build as pre-release if the dev stage is alpha, beta, or release candidate

Update the Encore-DMS website

  1. Pull the latest encore-dms.github.io repository changes and ensure everything is up-to-date by running: git pull; git submodule foreach --recursive "(git checkout master; git pull)"; git status
  2. Open the _config.yml file
  3. Replace the "version" property value with the new Encore version number
  4. Commit and push the change to GitHub