Protege Client Packaging on Dev

Precondition:

You have already built protege and the new version of the client is in /local/content/protege/protegedesktop

Overview

There are a number of extra files and folders that need to be added to the protege client before it is distributed to the editors.  The most recent copy of these can be found in the /local/project/protegeClientPackage folder.  A script in this folder will copy the protegedesktop folder into protegeClientPackage, name it with the appropriate tag, copy in the extra files, then zip the package.

Files and folders added to client package:

• bookmark : this folder contains SPARQL query text files for use in the SPARQL query tab.  New queries are usually sent over email and should be copied to this folder and checked into github at https://github.com/NCIEVS/sparql-query-plugin/tree/master/bookmark
• Protege Logs Email - Macro.xlsm : This is an Excel macro that allows users to send logs and error reports to the Protege admins.  Updates to this file are normally sent by email and should be copied to this folder
• removeOldPlugins.bat : Removes outdated plugins from Windows
• run.bat : Runs the protege client on Windows.  Overwrites the run.bat provided in the protegedesktop build. This differs from the provided run.bat in that it:
  • Calls the removeOldPlugins.bat
  • Increases the memory Xmx to 12000M
  • Calls the zulu jre
• run.bat.admin
• run.command : For running the Protege client on Mac
• runLowerMemory.bat : For running Protege client on Windows with a lower memory setting, for machines with resource constraints
• run.sh : For running the Protege client on Linux or from shell in Mac
• zulu8.38.0.13-ca-jre8.0.212-win_x64 : JRE for use in Windows

Running the packaging script

The main package script is package.sh. It is run by passing in the name of the new package "./package.sh nci-protege-V###"

This script will:

• Remove all existing nci-protege folders or zips
• Copy the /local/content/protege/protegedesktop folder into the current folder and rename it with the version
• Copy in the files and folders needed from the local directory into the nci-protege-V### directory
• zip the nci-protege-V###

This packaged protege client is not yet configured.  It is zipped up for convenience in copying to your local environment for further configuration.

There is a second script called localPackage.sh that does all the same functions except copying from the /local/content/protege/protegedesktop directory. This is useful for when you are doing manual builds or testing of the packaging process itself.