[Vtigercrm-commits] [vtiger development] #1066: Parse version from a version.txt file for formatted display in templates

[vtiger development]

#1066: Parse version from a version.txt file for formatted display in templates
----------------------------------+-----------------------------------------
 Reporter:  jeffk                 |       Owner:  developer
     Type:  defect                |      Status:  new      
 Priority:  major                 |   Milestone:  5.0.0    
Component:  vtigercrm             |     Version:  5.0.0    
 Keywords:  versioning packaging  |  
----------------------------------+-----------------------------------------
 As seen in [6355] and many other places in the codebase, vtigercrm
 displays the product name and version in many formats, such as:

  * vtiger CRM 5
  * vtiger CRM 5.0
  * vtiger CRM 5.0.0 Beta
  * vtigercrm-5.0.0beta1 (i.e. a disambiguated release version and package
 name)

 I propose a version.txt file be added to the repository, in the location
 vtigercrm/trunk/version.txt. The file would have content as follows:

 This file would have a parsable version of the the "name we're currently
 using for the next release", and would be updated in one place, rather
 than repeated throughout the codebase.
 {{{
 canonicalname:vtigercrm-5.0.0beta1
 productname:vtiger CRM
 }}}
 One or more functions added to a utils class would allow the parsed
 canonical name to be returned in a variety of formats:

  * Branded product name (marketing name): "vtiger CRM 5"
  * Versioned product display name: "vtiger CRM 5.0.0 Beta 1
  * Canonical product version and packaging name: "vtigercrm-5.0.0beta1

 The display name functions work by

  * parsing the canonical name
  * building a string using its some or all of the parsed ordinal number
 and postfix components
  * optionally subsituting the productname for the name portion of the
 canonicalname

 This would allow the templates to avoid unnecessary maintenance between
 revisions, and avoid 'bugs of oversight', whereby some instances of the
 name don't get updated because they are ungreppable.

 The exception where the name would be hardcoded into  source code would be
 a changelog. I propose that the changelog use the canonical product
 version and packaging name without exception.

-- 
Ticket URL: <http://vtiger.fosslabs.com/cgi-bin/trac.cgi/ticket/1066>
vtiger development <http://vtiger.fosslabs.com/>
vtigerCRM