Difference between revisions of "Features/Dotted Activity Versions"

From Sugar Labs
Jump to: navigation, search
(Current status)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<noinclude>{{TOCright}}
+
<noinclude>
[[Category:Feature Ready for Release Manager]]
+
[[Category:FeatureLanded|Dotted Activity Versions]]
[[Category:Feature|Dotted Activity Versions]]
+
</noinclude>
  
 
== Summary ==
 
== Summary ==
This Feature adds a minor part to the activity version. It will 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.
+
Extend the activity version numbering scheme to allow major and minor releases.
  
 
== Owner ==
 
== Owner ==
Line 12: Line 12:
  
 
== Current status ==
 
== Current status ==
* Targeted release: 0.88
+
* Targeted release: 0.92
* Last updated: Tue, 09. Feb 2010
+
* Last updated: Fri, 05 Nov 2010
* Percentage of completion: 80%
+
* Percentage of completion: 90%
  
 
== 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.
+
The new numbering scheme is more flexible and allows you to do major and minor releases. This is useful when you want to do for example a bug fix release. The new version number will consist of N integers separated by dots (e.g., 1, 1.2, 1.4.5, 2.5.7.4). You can still use an integer number only for your releases.
 +
 
 +
There is as well the ability to use a suffix for a local indicator (e.g., Peru wants to release a slightly modified version for their deployment 1.3-peru). The local indicator is a string, appended to the version. The local indicator does not apply alpha ordering, which means that 1.3-peru is equal to 1.3-argentina.
 +
 
 +
Valid:
 +
1
 +
1.2
 +
1.2.3
 +
2.4.6.7
 +
2.3-peru
 +
 
 +
Not valid:
 +
1.2peru        # must be separated with a '-'
 +
1.2.          # can't end with '.'
 +
1.02.5        # can't have a leading zero
 +
 
 +
Comparisons:
 +
12 == 12
 +
0.9.9 < 1
 +
1 == 1.0.0
 +
1.2 < 1.2.3
 +
1.2-arg == 1.2
 +
1.2-arg == 1.2-peru
  
 
== Benefit to Sugar ==
 
== Benefit to Sugar ==
 +
The new scheme gives activity developers more control on their releases. The separation between a major release and a minor (bugfix) release is more clearly visible. Since developers can still use just integer numbers the simplicity of the old scheme is kept.
  
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).
+
This scheme also enables developers who maintain older versions of Sugar, building activities with intermediate versions, in cases where it is not possible to use the latest changes because are not compatible.
  
 
== Scope ==
 
== Scope ==
 +
This feature does add a new class to the toolkit that is used to verify the correctness of the numbering string. The bundlebuilder and the activitybundle are adjusted accordingly ([http://bugs.sugarlabs.org/attachment/ticket/2425/0001-Adopt-to-new-numbering-scheme-2425.patch current toolkit patch]). In the shell the activity list and the bundleregistry has to change accordingly ([http://bugs.sugarlabs.org/attachment/ticket/2425/0001-Adopt-to-new-numbering-scheme-2425.patch current shell patch]).
  
This feature enhance the versioning scheme of activities. An optional field is added to the activity config file activity.info.
+
Furthermore the activity updater has to adopt to the new scheme.
  
 
==UI Design==
 
==UI Design==
  
The activity version is only visible in the activity list.
+
The new activity version is only visible in the activity list and the activity updater.  
  
 
== How To Test ==
 
== 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 ==
 
== User Experience ==
Line 45: Line 67:
 
== Contingency Plan ==
 
== Contingency Plan ==
  
None necessary, revert to previous release behaviour.
+
None necessary, revert to previous release behavior.
  
 
== Documentation ==
 
== Documentation ==
Documentation needs to be adjusted.
+
[[Development_Team/Almanac/Activity_Bundles#.info_file_format |The activity.info file documentation]] will be adjusted accordingly once this feature lands. The discussion about this feature has been taking place at this [http://www.mail-archive.com/sugar-devel@lists.sugarlabs.org/msg16943.html thread] on the sugar-devel mailing list.
  
 
== Release Notes ==
 
== Release Notes ==

Latest revision as of 13:59, 5 November 2013


Summary

Extend the activity version numbering scheme to allow major and minor releases.

Owner

  • Email: simon AT sugarlabs DOT org

Current status

  • Targeted release: 0.92
  • Last updated: Fri, 05 Nov 2010
  • Percentage of completion: 90%

Detailed Description

The new numbering scheme is more flexible and allows you to do major and minor releases. This is useful when you want to do for example a bug fix release. The new version number will consist of N integers separated by dots (e.g., 1, 1.2, 1.4.5, 2.5.7.4). You can still use an integer number only for your releases.

There is as well the ability to use a suffix for a local indicator (e.g., Peru wants to release a slightly modified version for their deployment 1.3-peru). The local indicator is a string, appended to the version. The local indicator does not apply alpha ordering, which means that 1.3-peru is equal to 1.3-argentina.

Valid:

1
1.2
1.2.3
2.4.6.7
2.3-peru

Not valid:

1.2peru        # must be separated with a '-'
1.2.           # can't end with '.'
1.02.5         # can't have a leading zero

Comparisons:

12 == 12
0.9.9 < 1
1 == 1.0.0
1.2 < 1.2.3
1.2-arg == 1.2
1.2-arg == 1.2-peru

Benefit to Sugar

The new scheme gives activity developers more control on their releases. The separation between a major release and a minor (bugfix) release is more clearly visible. Since developers can still use just integer numbers the simplicity of the old scheme is kept.

This scheme also enables developers who maintain older versions of Sugar, building activities with intermediate versions, in cases where it is not possible to use the latest changes because are not compatible.

Scope

This feature does add a new class to the toolkit that is used to verify the correctness of the numbering string. The bundlebuilder and the activitybundle are adjusted accordingly (current toolkit patch). In the shell the activity list and the bundleregistry has to change accordingly (current shell patch).

Furthermore the activity updater has to adopt to the new scheme.

UI Design

The new activity version is only visible in the activity list and the activity updater.

How To Test

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 behavior.

Documentation

The activity.info file documentation will be adjusted accordingly once this feature lands. The discussion about this feature has been taking place at this thread on the sugar-devel mailing list.

Release Notes

Comments and Discussion