diff --git a/content/en/docs/refguide/modeling/menus/edit-menu/preferences-dialog.md b/content/en/docs/refguide/modeling/menus/edit-menu/preferences-dialog.md index 37936b2205e..630af0bcb8e 100644 --- a/content/en/docs/refguide/modeling/menus/edit-menu/preferences-dialog.md +++ b/content/en/docs/refguide/modeling/menus/edit-menu/preferences-dialog.md @@ -161,6 +161,10 @@ This is the pattern from which the arguments are derived that are passed to the * `{0}` – this is replaced with the name of the original file before the arguments are passed to the file comparison program * `{1}` – this is replaced with the name of the changed file before the arguments are passed to the file comparison program +#### History {#history-pane} + +Select this option to use the blocking History dialog instead of the non-blocking, searchable History pane. + #### Solution Warning Select **Show warning on updating marketplace modules** to display a warning message when updating a Marketplace module. @@ -295,10 +299,6 @@ When **Extension Development** mode is enabled, you can start Studio Pro without Select this option to use the modernized version of the App Explorer. You must restart Studio Pro to use this feature. -### History Pane {#history-pane} - -Select this option to use the non-blocking, searchable History pane instead of the blocking History window. This feature is currently in beta. - ### Errors Pane Select this option to use the modernized version of the Errors Pane. You must restart Studio Pro to use this feature. diff --git a/content/en/docs/refguide/modeling/menus/version-control-menu/history-dialog.md b/content/en/docs/refguide/modeling/menus/version-control-menu/history-dialog.md index 12f8ac6ff8b..e482750e40b 100644 --- a/content/en/docs/refguide/modeling/menus/version-control-menu/history-dialog.md +++ b/content/en/docs/refguide/modeling/menus/version-control-menu/history-dialog.md @@ -5,93 +5,92 @@ weight: 50 --- ## Introduction -Use the **History** dialog box to look at all the changes that have been committed to a development line of an app. You can open this dialog box from the **Version Control** > **History…** menu item. This dialog box is also used when selecting a revision to merge from, create a branch line off, or to create a deployment archive from. +Use the **History** pane to see the changes that have been committed to a development line of an app. You can open this pane from the **Version Control** > **History…** menu item. The **History** pane displays all revisions at once in a searchable grid, making it easy to view the detailed project history. {{% alert color="info" %}} -In Studio Pro 11.4, the non-blocking, searchable **History** pane beta has been released. Open the pane by clicking **View** > **History**. You can set this feature as your default history view in the Preferences [New Features](/refguide/preferences-dialog/#history-pane) tab. -{{% /alert %}} +In Studio Pro 11.6, a new default view for History was introduced. Partially-cloned apps automatically get the older blocking dialog and through the [Version Control Preferences](/refguide/preferences-dialog/#history-pane), you can choose to keep using the blocking dialog for all apps. -{{% alert color="info" %}} - The **History** pane is not available when the app is partially cloned. -{{% /alert %}} +When using the Revision Selector to select a revision to revert, to merge from, create a branch line off, or to create a deployment archive from, the blocking dialog is still used. -The **History** dialog can display up to 250 commits at once, making it easy to look at the detailed project history. If the app was only partially copied, it may need to download missing data from the server. While the data is being downloaded, a progress bar will be shown. This initial download could take a little time, but once the data is saved locally, future access to the **History** dialog will be significantly faster — almost instant. +For more information on the blocking dialog, refer to the [Mendix 10 documentation](/refguide10/history-dialog/). +{{% /alert %}} ## Revisions {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/revisions.png" alt="Revisions Image" class="no-border" >}} -Each line in the grid represents a revision in the repository. For each revision the following information is shown, more information about each of these values is available below: +Each line in the grid represents a revision in the repository. + +### Search and Filters + +There are different filter options available to help find specific revisions: + +* The search bar looks in all fields of the revisions grid and in the details of the commit, such as the Model changes, Disk changes and Stories. +* The date filter allows specifying a date range for revisions. The available presets help to quickly select a range. +* The document filter allows selecting a document, such as a specific microflow, to filter all revisions on. + +### Content + +For each revision the following information is shown, more information about each of these values is available below: * [Revision](#revision) -* [Changes](#changes) +* [Status](#status) * [Author](#author) -* [Date](#date) -* [Time](#time) +* [Date/Time](#datetime) * [Message](#message) By selecting a revision in this grid, the tabs below the grid will be filled with information about this revision. -### Revision{#revision} +#### Revision{#revision} A unique alphanumeric identifier of the revision in the repository. The revision identifier is the Git hash for the commit and is unique for a whole repository. -### Changes{#changes} +#### Status{#status} -A visual summary of the changes in the selected revision, each icon represents different type of change: +Shows the state of the revision in relation to the server. It can have one of the following values: -| Icon | Change Type | Notes | -| --- | --- | --- | -| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/MergeRevision.png" width=32 alt="Merge commit icon" class="no-border" >}} | Merge commit | Indicates that the commit is a merge of two different commits.
Hovering over will show both the parent [revisions](#revision). | -| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesModel.png" width=32 alt="Model changes icon" class="no-border" >}} | Model changes | Indicates that there were some changes made to the app model.
For example, changes to the domain model, microflows, or pages. | -| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesDisk.png" width=32 alt="Changes on disk icon" class="no-border" >}} | Changes on disk | Indicates that there were changes on disk.
For example, a file was added or removed. | -| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesVersion.png" width=32 alt="Studio Pro changes icon" class="no-border" >}} | Studio Pro changes | Indicates that there was a change to the Studio Pro version used to work with the app.
For example, when upgrading the app from a previous version to the latest one. | -| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/Solution.png" width=32 alt="Solution version changes icon" class="no-border" >}} | Solution version changes | Indicates that a [solution module](/refguide/configure-add-on-and-solution-modules/) used in the app was updated. | +* **Synced** – shown when revision exists locally as well as on the server +* **Local** – shown when the revision is only available locally, because a local commit was made +* **On server** – shown when the revision is only available on the server; this is an indicator there is incoming work that will have to be merged before being able to push new commits to the server -Hover over this column in Studio Pro to get a textual summary of the changes. - -### Author{#author} +#### Author{#author} The person who committed the change. -### Date{#date} - -The date the revision was created, it can have one of the following values: +#### Date/Time{#datetime} -* **Today** - shown when revision was created today. -* **Yesterday** - shown when revision was created yesterday. -* the date - shown when the revision was created earlier than yesterday. +The date the revision was created. -### Time{#time} +#### Message{#message} -The time the revision was created. - -### Message{#message} - -The message saved with the commit. If the message is long, you can read it more easily in the Message tab page, below. +The message saved with the commit. If the message is long, you can read it more easily in the **Message** tab page by selecting the revision. ## Details of Revisions -Below the grid are a number of tabs which give further details about the currently-selected revision. +On the right of the grid are a number of tabs which give further details about the currently-selected revision. ### Message This tab shows the message saved when these changes were committed. -### Related Stories - -This tab shows a list of stories that are related to the changes. +The **Mendix version** that was used to commit the revision to the model is also shown. -### Changes in Model +### Model Changes This tab shows a list of documents that were changed in the selected revision. From here you can jump to the currently selected changed document by clicking **Go to**, assuming the document still exists in the current version. -The **Mendix version** that was used to commit the revision to the model is also shown. +The search bar within the tab can be used to filter the list of documents. -### Changes on Disk +### Disk Changes This tab shows a list of the files that were changed on disk. You can see whether files were added, deleted or modified. +The search bar within the tab can be used to filter the list of files. + +### Stories + +This tab shows a list of stories that are related to the changes. + ## Read More * [Version Control](/refguide/version-control/) diff --git a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/MergeRevision.png b/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/MergeRevision.png deleted file mode 100644 index 3d613eeb06b..00000000000 Binary files a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/MergeRevision.png and /dev/null differ diff --git a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesDisk.png b/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesDisk.png deleted file mode 100644 index 73ea1f85c3a..00000000000 Binary files a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesDisk.png and /dev/null differ diff --git a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesModel.png b/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesModel.png deleted file mode 100644 index e0f9478affd..00000000000 Binary files a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesModel.png and /dev/null differ diff --git a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesVersion.png b/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesVersion.png deleted file mode 100644 index 9cf54772a5e..00000000000 Binary files a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesVersion.png and /dev/null differ diff --git a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/Solution.png b/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/Solution.png deleted file mode 100644 index 23c5760083f..00000000000 Binary files a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/Solution.png and /dev/null differ diff --git a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/revisions.png b/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/revisions.png index c5b6a7c8a90..dd12683a714 100644 Binary files a/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/revisions.png and b/static/attachments/refguide/modeling/menus/version-control-menu/history-dialog/revisions.png differ