Features/Dotted Activity Versions: Difference between revisions

Line 1:

<noinclude>~~{{Dated|See this [http://www.mail-archive.com/sugar-devel@lists.sugarlabs.org/msg16943.html discussion thread] for more up-to-date information.}}~~

[[Category:Feature ~~Accepted 0.88~~]]

[[Category:Feature Page Incomplete]]

[[Category:Feature|Dotted Activity Versions]]

== 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 ==

Line 12:

== 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 ==

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 -

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 ==

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. An optional field is added to the activity config file activity.info.~~

==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 ==

* 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 ==

Line 45:

Line 65:

== Contingency Plan ==

None necessary, revert to previous release ~~behaviour~~.

None necessary, revert to previous release behavior.

== Documentation ==

~~Documentation needs to~~ be adjusted.

[http://wiki.sugarlabs.org/go/Development_Team/Almanac/Activity_Bundles#.info_file_format The activity.info file documentation] will be adjusted accordingly once this feature has landed. 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 ==

@@ Line 1: / Line 1: @@
-<noinclude>{{Dated|See this [http://www.mail-archive.com/sugar-devel@lists.sugarlabs.org/msg16943.html discussion thread] for more up-to-date information.}}
+<noinclude>
-[[Category:Feature Accepted 0.88]]
+[[Category:Feature Page Incomplete]]
 [[Category:Feature|Dotted Activity Versions]]
 == 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 ==
@@ Line 12: / Line 12: @@
 == 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 ==
-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:
+.2
+.2.3
+.4.6.7
+.3-peru
+Not valid:
+.2peru        # must be separated with -
+.2.           # can't end with '.'
+.02.5         # can't have a leading zero
+Comparisons:
+== 12
+.9.9 < 1
+== 1.0.0
+.2 < 1.2.3
+.2-arg == 1.2
+.2-arg == 1.2-peru
 == 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. An optional field is added to the activity config file activity.info.
 ==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 ==
-* 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 ==
@@ Line 45: / Line 65: @@
 == Contingency Plan ==
-None necessary, revert to previous release behaviour.
+None necessary, revert to previous release behavior.
 == Documentation ==
-Documentation needs to be adjusted.
+[http://wiki.sugarlabs.org/go/Development_Team/Almanac/Activity_Bundles#.info_file_format The activity.info file documentation] will be adjusted accordingly once this feature has landed. 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 ==