Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Sirius/Compatibility and Migration"
< Sirius
(Created page with "This page documents the compatiblity policy for Sirius releases, both for users of the Viewpoint technology (the previous name of Sirius) who want to switch to Sirius and from...") |
(→Migration Paths) |
||
Line 30: | Line 30: | ||
=== General Rules === | === General Rules === | ||
+ | * Stepwise migration: first to the latest version of Viewpoint available, then to Sirius 0.9.0, then each milestone in turn up to 1.0.0 final. | ||
+ | * For a given project, document in which order to migration the VSMs, APIs, aird etc. | ||
− | === Migrating from | + | === Migrating from === |
[[Category:Sirius]] | [[Category:Sirius]] |
Revision as of 11:28, 21 November 2013
This page documents the compatiblity policy for Sirius releases, both for users of the Viewpoint technology (the previous name of Sirius) who want to switch to Sirius and from new adopters of Sirius itself.
Contents
Background
Overview of the Sirius Releases Roadmap Until 1.0
Objective and General Rules
In general incompatible changes between two versions should be the exception and not the general rule. Any incompatible change should be clearly justified and its impacts minimized.
The rules:
- whenever possible, allow seamless and transparent migration;
- if that is not possible, provide automated or semi-automated tools to assist in the migration. These tools should be usable programmatically (no just by UI actions) to allow users with lots of existing data to automate the migration.
- if automation is not possible or considered too costly, provide complete documentation of the manual steps to perform to migrate existing projects.
In all cases (even when the migration can be handled transparently), all changes should be clearly documented in the release notes of the release or milestone in which they appear first.
Types of Compatibility Issues
- VSM
- Representations Files
- Modeling Projects
- Plug-in dependencies
- Extension points and other ids
- Java namespaces
- Java APIs
Migration Paths
General Rules
- Stepwise migration: first to the latest version of Viewpoint available, then to Sirius 0.9.0, then each milestone in turn up to 1.0.0 final.
- For a given project, document in which order to migration the VSMs, APIs, aird etc.