google-code-export / marinemap

Automatically exported from code.google.com/p/marinemap
Other
1 stars 2 forks source link

Add client versioning scheme to MarineMap applications #456

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
MarineMap instances that want to display other instance's sidebar content will 
need to know what version of client code those instances are operating on.

Say instance A wants to access instance B's content. But instance B is running 
a later version of marinemap that introduced advanced client-side data 
visualization capabilities. Version A can't display version B's content since 
it doesn't have that functionality.

The solution to this is semantic versioning:
http://semver.org/

In lingcod, we'll need to have a CLIENT_VERSION setting somewhere that can be 
incremented for changes. We'll also need in each project a 
REQUIRES_CLIENT_VERSION setting somewhere to indicate what CLIENT_VERSION the 
project's sidebar content requires.

So in our example,

instance a
CLIENT_VERSION = 1.1.0

instance b
CLIENT_VERSION = 1.5.2
REQUIRES_CLIENT_VERSION = 1.5.0

instance a can't show B's content, but since instance b has only minor version 
differences, it can show A's content.

Here would be an example of different version that are compatible:

instance a
CLIENT_VERSION = 1.1.5

instance b
CLIENT_VERSION = 1.1.8
REQUIRES_CLIENT_VERSION = 1.1

In this case, there are only some bugfix-type releases differing. However, if 
instance b required on of those bugfixes, it could specify a more discrete 
REQUIRES_CLIENT_VERSION number.

The deliverable for this ticket is to add these variables and document how to 
use them.

Original issue reported on code.google.com by underbluewaters on 6 Dec 2010 at 7:10

GoogleCodeExporter commented 9 years ago

Original comment by underbluewaters on 7 Feb 2011 at 8:08

GoogleCodeExporter commented 9 years ago

Original comment by underbluewaters on 7 Feb 2011 at 8:19

GoogleCodeExporter commented 9 years ago

Original comment by underbluewaters on 7 Feb 2011 at 8:19

GoogleCodeExporter commented 9 years ago

Original comment by perrygeo...@gmail.com on 20 Sep 2011 at 8:27