Workflows - archimatetool/archi-modelrepository-plugin2 GitHub Wiki

[!NOTE] coArchi supports several workflows. But the primary workflows are described below.

Local model with no online repository

With this workflow (as described in the Quick Start you can add an existing Archi model or a new Archi model to the Collaboration Workspace without setting any online repository details. This workflow allows you to maintain a local history of commits and branches without synchronising with other users.

  • Easy to set up
  • No need to decide on the location of the online repository
  • Can set the location of the online repository later
  • Provides a quick and easy to maintain local history and versioning

Set up an empty online repository

This is the same as the previous workflow but you have already created a new, empty, online repository as described here. When you're happy with your local changes you can Publish to this online repository.

  • Easy to set up
  • Provides a quick and easy to maintain local history and versioning
  • Publish when ready

Import an existing repository

In this workflow you will import an existing Archi model from a known online repository. The model can then be used and synchronised by using the Commit, Refresh and Publish actions.

  • Use when colleagues have already created the online repository
  • Use when you want to import the model on another machine or instance of Archi

Overall workflow

The day-to-day workflow once established as above basically consists of:

  1. Work on the model
  2. Save the model
  3. Add commits in the local repository at strategic points
  4. Create branches as required
  5. Refresh the repository to synchronise with remote changes
  6. Handle merging and any conflicts (note - this is not currently fully implemented)
  7. Publish your changes to the online repository