Ways of Co-working on a Capella Project
Quick Comparision
| Git | TeamForCapella | |
|---|---|---|
| Multiple workstreams | Different workstreams available via branches | Not recommended, only possible via different repositories |
| Concurrent working | Very challenging because of merge conflict potential. | Is possible. Diagrams are locked, no risk of merge conflicts. |
| Merge conflicts | Resolution of merge conflicts can be challenging. | No merge conflicts when one workstream is used. For multiple workstreams, the resolution of merge conflicts can be challenging. |
| License | No license needed1 | TeamForCapella license required2 |
| Complexity | Git knowledge is required3 | Easy to use |
| Stability | Very stable solution as changes are initially saved locally. Temporary server downtimes can also be bridged. | Changes may be lost if the server becomes unavailable during work. |
| Potential of data loss | Changes are backed up after each push (more regularly). | Changes are backed up on a nightly basis. |
| Automation | Possible via CI/CD in the Git repository. | Possible via TeamForCapella → Git synchronisation (runs on a nightly basis). |
| Change control | Reviews are possible via merge requests4 | Change control is nearly impossible, no barriers. |
| Release tagging | Directly possible via tags in Git. | Possible via TeamForCapella → Git synchronisation (Releases are stored as tags in the Git repository). |
Some General Words
- Git-only - the modeling team uses a git repository to work on the model. The team may use git branches to work on features or capabilities in parallel and a main branch is used for integration and release-tagging. This way of working gives the modeling leads / change control board great control over what contents make it to the model that is used for releases (of things like design documentation). On the downside this co-working method is fairly complicated and requires skilled modeling leadership for challenges like merge conflict resolution and fragmentation management (a way to break up model into smaller files to reduce density of merge conflicts).
-
Git + TeamForCapella - with this approach the modeling team can co-work with a very high degree of concurrency and stay away from the difficulties of merge conflict resolution. On the downside it is much harder to control what makes it into the model as there is no barrier except for maybe a modeling process that would stop a person from making changes that are not allowed. Yet there are a few ways around that limitation. For teams with basic or no experience in modeling and git this is probably the best way to start co-woking. Git is still used for nightly backup of the model and release-tagging.
Info: TeamForCapella license required
For this co-working method to be enabled you need a valid TeamForCapella license and TeamForCapella server installed and integrated with Collab-Manager.
-
You can use any standardized Git server. Depending on the server used, licenses for the Git server may be required. ↩
-
You need a valid TeamForCapella license and TeamForCapella server installed and integrated in the Collaboration Manager. ↩
-
For the basic workflow, a simple Git knowledge that includes commit, pull and push is sufficient. However, it is necessary to have at least one Git expert in the project to deal with potential merge conflicts and unexpected situations. ↩
-
To review changes, the Eclipse EMF diff/merge tool can be used. However, in practice this proves to be too time-consuming, as many changes become confusing very quickly. ↩