-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Describe TeamForCapella commit and commit description options
Described how to activate commit messages / descriptions, how to enter a commit message and describe the commit history.
- Loading branch information
1 parent
7197b80
commit f427a91
Showing
12 changed files
with
58 additions
and
0 deletions.
There are no files selected for viewing
Binary file added
BIN
+9 KB
...ocs/user/tools/capella/teamforcapella/commit-messages/commit-history-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
Binary file added
BIN
+88.1 KB
.../docs/user/tools/capella/teamforcapella/commit-messages/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.
2 changes: 2 additions & 0 deletions
2
docs/docs/user/tools/capella/teamforcapella/commit-messages/commit-history-view.png.license
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
Binary file added
BIN
+79.5 KB
...tools/capella/teamforcapella/commit-messages/enable-description-for-commits.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions
2
...r/tools/capella/teamforcapella/commit-messages/enable-description-for-commits.png.license
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
Binary file added
BIN
+27.7 KB
...docs/user/tools/capella/teamforcapella/commit-messages/enter-commit-message.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions
2
docs/docs/user/tools/capella/teamforcapella/commit-messages/enter-commit-message.png.license
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
49 changes: 49 additions & 0 deletions
49
docs/docs/user/tools/capella/teamforcapella/commit-messages/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
Binary file added
BIN
+26.7 KB
docs/docs/user/tools/capella/teamforcapella/commit-messages/open-preferences.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions
2
docs/docs/user/tools/capella/teamforcapella/commit-messages/open-preferences.png.license
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters