Skip to content

Commit

Permalink
docs: Describe TeamForCapella commit and commit description options
Browse files Browse the repository at this point in the history
Described how to activate commit messages / descriptions,
how to enter a commit message and describe the commit history.
  • Loading branch information
MoritzWeber0 committed Apr 5, 2024
1 parent 7197b80 commit f427a91
Show file tree
Hide file tree
Showing 12 changed files with 58 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
SPDX-License-Identifier: Apache-2.0
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
SPDX-License-Identifier: Apache-2.0
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
SPDX-License-Identifier: Apache-2.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<!--
~ SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
~ SPDX-License-Identifier: Apache-2.0
-->

# Work with TeamForCapella commits and commit messages

!!! Info

Please [request a persistent Capella session](../../../../sessions/request.md) before you continue
with the instructions here.

## Activate commit messages

If you want to provide commit messages when saving your changes in
TeamForCapella, you can enable a dialog that will prompt you to enter a message
each time you save your changes:

1. Navigate to `Window` > `Preferences`: <br>
![Preferences menu](./open-preferences.png)
1. In the `Preferences` dialog, navigate to `Sirius` > `Team Collaboration` and
activate the `Require description for commit actions` option: <br>
![Sirius Team Collaboration Options](./enable-description-for-commits.png)
1. Save the changes with "Apply and Close".

## Provide a commit message

!!! Warning

The commit description dialog will only appear if activated as described in the previous section.

1. Connect to a TeamForCapella repository.
1. Make some changes to the model.
1. Save your changes. A dialog will prompt you to enter a commit message:
![Commit message dialog](./enter-commit-message.png)
1. Confirm with "OK". If you don't want to provide a commit message, you can
click on "Ignore".

## View the commit history

1. Open the Capella search via the search icon in the top right corner.
1. Search for commit history and select
`Commit History (Sirius Team collaboration)`: <br>
![Capella search for commit history](./commit-history-search.png)
1. The commit history view opens. It will show the changes of the selected
element and children in the project explorer. Select the `.aird` file for
the full project commit history. You can click on specific commits to see
the modified elements: <br>
![Commit History view](./commit-history-view.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
SPDX-License-Identifier: Apache-2.0
1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ nav:
- Connect to a TeamForCapella Repository: user/tools/capella/teamforcapella/connect/connect-to-t4c.md
- Import a Model from TeamForCapella: user/tools/capella/teamforcapella/import/import-from-t4c.md
- Export a Model to TeamForCapella: user/tools/capella/teamforcapella/export/export-to-t4c.md
- TeamForCapella commits and commit messages: user/tools/capella/teamforcapella/commit-messages/index.md
- Git:
- Working with Git: user/tools/capella/git/working-with-git.md
- Troubleshooting: user/tools/capella/troubleshooting/index.md
Expand Down

0 comments on commit f427a91

Please sign in to comment.