Commit Changes - archimatetool/archi-modelrepository-plugin2 GitHub Wiki

Commit Changes

This action creates a commit from the most recent changes to a model. It is available from the main "Collaboration" menu and toolbar, the Collaboration Workspace, and the right-click context menu of the Change History.

Background

A commit is a snapshot of changes made to the model in the local repository at a specific point in time. It’s like saving a version of the model, along with a unique identifier, a message, and the author and time-stamp.

Key Points About Commits:

  1. Snapshot of Changes: Each commit records the changes made since the previous commit, storing the state of the repository’s model
  2. Unique Identifier: Every commit has a unique SHA-1 hash (a 40-character string, often shortened) that identifies it
  3. Commit Message: You provide a message when committing to describe what changes were made, helping others (and yourself) understand the purpose of the commit
  4. Immutable: Once created, a commit is permanent unless explicitly amended, preserving the model's history
  5. Part of History: Commits form a chain, creating a history of changes that you can navigate, revert, or branch from

Working Changes

If there are uncommitted saved changes a row will appear at the top of the Change History table called "Working Changes". This indicates that a commit is needed.

Make a Commit

  1. Select the "Commit Changes" action from the menu or toolbar. The following dialog will appear:
  1. If you have previously added your user name and email address in Preferences these fields will be populated. If not, add them now.
  2. Add a message to the main text box that describes the change. The message should be a single line that summarises the change concisely. Additional text can be added after a space below this line.
  3. If you wish to amend the previous commit check the checkbox. This will over-write the previous commit with the changes in this commit. Note that this option is not available if the previous commit has been published to the remote repository or the commit is one that has been merged.
  4. Click OK

[!IMPORTANT] Commits are created in the local repository. You should Publish them to the remote repository when ready.