Skip to content

Commit

Permalink
document process application milestone versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
christinaausley committed Jun 20, 2024
1 parent 84ed63b commit 912acdd
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/components/modeler/web-modeler/milestones.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ Alternatively, you can create a new milestone via the breadcrumb menu in the dia

When dragging and dropping a file into the diagram view, or when using the **Replace via upload** option under the breadcrumb menu, a new milestone is created automatically.

#### Bulk milestone creation

[Process applications](/components/modeler/web-modeler/process-applications.md) are a special type of folder in Web Modeler that allows you to work on a set of related files and
[deploy](/components/modeler/web-modeler/process-applications.md#deploy-and-run-a-process-application) them together in a single bundle with just one click. This reduces the risk of having a broken deployment at runtime and makes it more convenient to deploy related files.

When creating a milestone on a main process of a process application, milestones are created for all other assets in the application to make it easier to track or roll back changes. Depending on your solutions approach, these milestones are either independently managed from the main process, or are tied to the main process and cannot be modified.

### Restoring milestones

Hover over a milestone, click on the three vertical dots, and expand for more options.
Expand Down
10 changes: 10 additions & 0 deletions docs/components/modeler/web-modeler/process-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,16 @@ Note that when you deploy the process application:
- Linked external forms will be deployed together with the process application.
- Linked external BPMN and DMN diagrams are _not_ deployed together. They must be deployed separately.

## Milestones

You can save a snapshot of your diagram as a milestone any time. If you make any mistakes while modeling, you can always go back to previously saved snapshots. You can also identify and compare the differences between two milestones.

You can also add version tags to these milestones, and create milestones for all resources of given process applications. For more information, review the [milestone documentation](/components/modeler/web-modeler/milestones.md).

### Versioning

When creating a milestone, name your milestone with a version tag to track it through the development lifecycle and ensure the correct version is called. To do this, enter a **Version tag** within the **Create a milestone** modal and click **Create**.

## Limitations

Be aware of the following limitations when working with process applications:
Expand Down

0 comments on commit 912acdd

Please sign in to comment.