MCS Build and Release Guide

From MCS

Note Note: This is a developer guide.

Pre-Requisites

See Development Notes for details of development environment set-up.


Start with the QA TFS stream.

Create a new TFS branch for the new version.

Ensure that all code has been brought in or created in this stream.

Change the JavaScript and Build versions:

  • app.js - change MCS.App.Version to the new version number.
  • Web.config - change JSVersion to the new version number.

Ensure that the code builds.

Check in all code changes to the new TFS branch.


Build the Release

Right-click on WebSite.

Select Publish Web App.

  • Connection:
    • File System - specify a local target location.
  • Settings:
    • Configuration: Release.

Click Publish.


Prep for Release

Copy the local release folder and contents to \\spekefs2012\Projects\Releases\MCS\Release\.

Rename Web.config to Web.config.release.

Rename this copied folder to the version name e.g. MCS_v.vv.vv.vvv.

Zip the folder to the same name.


Release Documentation

Create a new release note in this Assist system:

  • From the navigation menu, choose Help/Creating new documents from templates.
  • Choose Create release note.
  • Enter a release note name in the format "REL (System) (Version)", for example "REL C-MCS v2.00.00.000".
  • Click Create Release note.
  • In the page that opens, change the 4 lines here to reflect the release note details:
{{#vardefine:System|''CALIDUS'' Mobile/TTM/Vision/ePOD, etc}}
{{#vardefine:SystemCode|WCS/MCS/EPOD, etc}}
{{#vardefine:Version|Release version no}}
{{#vardefine:Date|7th February 2020}}
  • For example:
{{#vardefine:System|''CALIDUS'' MCS}}
{{#vardefine:SystemCode|MCS}}
{{#vardefine:Version|2.00.00.000}}
{{#vardefine:Date|7th February 2020}}
  • Update Platforms/Database section with any restrictions that the product has regarding releases, for example operating system, browser, etc.
  • Update Related Documents section to note any controlled documents that might be of use here. For example, if there is an Assist page that identifies the functionality changes, reference that.
  • Update User Notes section to update site, or remove this line if inapplicable.
  • Update Released Incidents / Changes section to include a line for each change included in the release notes. Add a line with the log references and title of the log, plus a description of the functionality added. Describe in user terms, not technical terms. For example "Fixed a bug where printer cannot be selected at Pallet Build" is a good comment, whereas "Fixed a bug in ui103lt3b_001.cs to add onLoad event" is not.
  • Update Setup section to include any configuration steps that are required by the user. Be detailed with the individual flags and parameters, identifying system if necessary.
  • Update User Instructions section, explaining where process has changed because of the changes included in this release, including the log reference.
  • Update Performance Notes section, to indicate where performance of the system or the operation might be impacted by the changes in this release.
  • Update Related Releases section, to show related releases, for this system or any other system. For example, if an MCS release is dependent on a specific C-TMS release, reference that here.
  • Update Technical Changes & Special Notes section, for any other technical information that the customer might need to know. For example, if the changes require specific hardware or hardware configuration, for example a scanner, a signature pad, a specific monitor size, list this here. Any system tasks or changes that must be made to the application that cannot be made by the customer should also be listed here.

Save the release note in \\spekefs2012\Projects\Releases\MCS\Release Notes\.

Update the release log in \\spekefs2012\Projects\Releases\MCS\.


Release

On the customer machine, locate the customer MCS installation to be updated.

Delete any prior back-ups if appropriate.

Back-up the existing folder and zip it.

Copy the new release into the MCS installation folder.

Extract the contents of the new release zip over the existing folder.

Check and compare Web.config to Web.config.release - make any changes to the customer MCS installation version to reflect new keys added to the file.

Restart the system through IIS.

Inform the customer through email with the release note attached.