Skip to content

Commit 5831b9a

Browse files
Refguid update for mechanism to allow to wait for autogeneration completion
1 parent 06f417a commit 5831b9a

4 files changed

Lines changed: 25 additions & 1 deletion

File tree

content/en/docs/refguide/modeling/menus/version-control-menu/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The **Pull** option updates the local app to the latest revision that was commit
1717

1818
## Commit
1919

20-
The **Commit** option commits all local changes made to the app since the previous commit to the version control server. For more information, see [Commit](/refguide/commit-dialog/).
20+
The **Commit** option commits all local changes made to the app since the previous commit to the version control server. For more information, see [Commit](/refguide/commit-dialog/). The commiting process starts with handling asynchronous content generation by waiting for completion, preventing unexpected post-commit file changes (such as *theme.compiled.css.map*) and providing troubleshooting options if errors or timeouts occur, see [Synchronizing commit content](/refguide/sync-commit-content/).
2121

2222
## Push{#push}
2323

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "Synchronizing commit content"
3+
url: /refguide/sync-commit-content/
4+
weight: 30
5+
---
6+
7+
8+
There are several components in StudioPro where some files on disk need to be generated for the App to function. For example:
9+
- Theme cache,
10+
- JavaScript Actions,
11+
- Java Actions,
12+
- etc.
13+
14+
These files are generated based on the Documents in the App. In some cases generation of these files takes long time (typically proportional to the app size). This is why we cannot add those generated files to *.gitignore* file – it might slow down App opening and cause errors in some editors.
15+
Due to the above we introduced an additional step in **Prepare commit process** that ensures generated content is up to date and generation is complete before Committing the changes to the repository.
16+
17+
The last step on the dialog below calls synchronization commit content. The current kind of synchronization is displayed in Progress.
18+
19+
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/sync-commit-content/prepare-commit-process.png" alt="Prepare commit process" >}}
20+
21+
If any synchronization fails during this step the form below is displayed asking if it should continue or cancel commit process explaining the failures and statuses. The form lists only the synchronizers that have failed.
22+
23+
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/sync-commit-content/sync-failure-dialog.png" alt="Synchronization failure dialog" >}}
24+
36.2 KB
Loading
33.5 KB
Loading

0 commit comments

Comments
 (0)