Difference between revisions of "Features/Dotted Activity Versions"

From Sugar Labs
Jump to: navigation, search
(Detailed Description)
Line 4: Line 4:
  
 
== Summary ==
 
== Summary ==
 
+
This Feature adds a minor part to the activity version. The idea is to reuse the existing activity_version field as the major part (integer). A new field will be introduced that will be the minor part (fraction) of the new floating point activity version.
Let activity developers release bugfix versions and do not mess them with already released new versions(e.g. bugfix for several-versions-ago release w/o breaking/confusing-users existed versioning scheme).
 
  
 
== Owner ==
 
== Owner ==
 
''This should link to your home wiki page so we know who you are''
 
''This should link to your home wiki page so we know who you are''
* Name: [[User:AcountName| Your Name]]
+
* Name: [[Erikos:AcountName| Simon Schampijer]]
  
 
''Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or technical issues need to be resolved''
 
''Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or technical issues need to be resolved''
Line 20: Line 19:
  
 
== Detailed Description ==
 
== Detailed Description ==
 
+
A new field is added to the activity.info file (activity_minor_version). Internally the activity version will become represented as a float, constructing the value of the minor and major part if the minor part is available. Otherwise the activity version is converted to a float.
In case of backwards compatibility (how < 0.88 and >= 0.88 users will see new version), there could be several options:
 
 
 
* use two separate ''activity.info'' fields for version, existing ''activity_version'' and new one with new full version. < 0.88 user will see ''activity_version'', and >= 0.88 version from new field could lead to various misunderstanding e.g. why ''activity_version'' has one value and ''new_field'' has another one
 
 
 
* reuse existing ''activity_version'' field as a major part of dotted version and new field for minor part, < 0.88 user will see only ''activity_version'' and >= 0.88 will see ''activity_version''.''new_field'' version, in that case we don't break existing versioning line e.g. Browse-104 will be Browse-104 (even after adding new version w/ incremented ''new_field'' value) for all sugars(but >= 0.88 users will see incremented part)
 
 
 
* reuse existing ''activity_version'' field as a minor part of dotted version and new field for major part < 0.88 user will see only ''activity_version'' and >= 0.88 ''new_field''.''activity_version'' version also doesn't break versioning line but could confuse >=0.88 users who upgrade their sugar to 0.88 and will see Browse-2.105
 
  
 
== Benefit to Sugar ==
 
== Benefit to Sugar ==
Line 35: Line 27:
 
== Scope ==
 
== Scope ==
  
This feature could affect versioning scheme of all existed activities.
+
This feature enhance the versioning scheme of activities.
  
 
==UI Design==
 
==UI Design==
  
Nothing.
+
The activity version is only visible in the activity list.
  
 
== How To Test ==
 
== How To Test ==
{{:{{PAGENAME}}/Testing}}
+
- add the minor part to an activity.info file of an activity
 +
- you should be able to change the favorite status in the activities list of new and old style activities
 +
- you should be able to install activities (check newer and older versions of the same activity, too)
 +
 
 
== User Experience ==
 
== User Experience ==
 
''If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice.''
 
''If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice.''
Line 55: Line 50:
  
 
== Documentation ==
 
== Documentation ==
 
* [http://www.mail-archive.com/sugar-devel@lists.sugarlabs.org/msg10591.html Activity Versioning - Dotted Scheme]
 
  
 
== Release Notes ==
 
== Release Notes ==
''The Sugar Release Notes inform end-users about what is new in the release. An Example is [[0.84/Notes]]. The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the release team and shipped with the release.''
 
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
 
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page. -->
 
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page. -->

Revision as of 01:53, 9 February 2010

Summary

This Feature adds a minor part to the activity version. The idea is to reuse the existing activity_version field as the major part (integer). A new field will be introduced that will be the minor part (fraction) of the new floating point activity version.

Owner

This should link to your home wiki page so we know who you are

Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or technical issues need to be resolved

  • Email: <your email address so we can contact you, invite you to meetings, etc.>

Current status

  • Targeted release: 0.88
  • Last updated: Sun Dec 6 03:13:02 UTC 2009
  • Percentage of completion: 0%

Detailed Description

A new field is added to the activity.info file (activity_minor_version). Internally the activity version will become represented as a float, constructing the value of the minor and major part if the minor part is available. Otherwise the activity version is converted to a float.

Benefit to Sugar

Let activity developers release bugfix versions and do not mess them with already released new versions(e.g. bugfix for several-versions-ago release w/o breaking/confusing-users existed versioning scheme).

Scope

This feature enhance the versioning scheme of activities.

UI Design

The activity version is only visible in the activity list.

How To Test

- add the minor part to an activity.info file of an activity - you should be able to change the favorite status in the activities list of new and old style activities - you should be able to install activities (check newer and older versions of the same activity, too)

User Experience

If this feature is noticeable by its target audience, how will their experiences change as a result? Describe what they will see or notice.

Dependencies

Regular glucose dependencies.

Contingency Plan

None necessary, revert to previous release behaviour.

Documentation

Release Notes

Comments and Discussion