File Lifecycle Tagging

[engineering-issue-sync-app[bot]]

Value Proposition Statement

Easily track and communicate deployment statuses and other relevant metadata, improving collaboration and project management, and enabling deployment automation.

User Problem

• Users currently lack the ability to indicate and manage custom states or statuses of files + milestones in the Web Modeler.
• Inadequate means to track and communicate deployment statuses or other custom metadata associated with files + milestones.
• Users require a flexible and scalable solution to accommodate their unique tagging needs.
• Automating workflows based on milestone states is currently not effective, as the only way to tag milestones is by updating the milestone name with a machine-readable descriptor.

Context

• Web Modeler allows versioning of files, including BPMN diagrams, using milestones.
• Milestones represent different versions of files and can be managed via the REST API.
• Users want to reflect customer-defined states, such as deployment statuses, using custom tags.
• The feature should support multiple tags for each milestone.
• Tags must be manageable and searchable through the REST API to enable integration and automation.

Technical Problem

• There is no existing mechanism to manage and communicate custom metadata for milestones.
• The REST API does not provide endpoints to update milestone descriptions, which could have been a workaround.

User Stories

Implementation Notes

• To support the initial feature request to reflect deployment states of milestones, it is sufficient to enable this via the API in a first iteration
• In a second one, we can add editing+display of these tags in the milestone view
• We could benefit from having these tags also on the latest state (the "draft" or edit state), for example to reflect if a diagram is currently in design, or ready to handover to IT.

^{:robot: This issue is automatically synced from: source}

[christian-konrad]

Example tags:

Deployment Status: Tags such as deployed:production, deployed:staging, or deployed:testing can be used to indicate the deployment status of a milestone on different environments.

Review Status: Tags like review:pending, review:approved, or review:rejected can be used to track the review status of a milestone, making it easier to identify which milestones require review or have already been reviewed.

Release Version: Tags like version:1.0, version:2.1, or version:3.5 can be used to indicate the release version of a milestone, facilitating version control and ensuring accurate documentation of the project's progress.

Testing Status: Tags such as testing:pass, testing:fail, or testing:incomplete can be used to track the testing status of a milestone, enabling users to identify milestones that have passed or failed testing or require additional testing.

Integration Status: Tags like integration:complete, integration:in progress, or integration:pending can be used to represent the integration status of a milestone with external systems or components, providing visibility into the integration process.

Custom Workflow Stages: Tags such as stage:design, stage:development, stage:testing, or stage:deployment can be used to define and track custom workflow stages specific to the project, allowing users to organize milestones based on their progress within the defined stages. It also allows for easy business-to-IT handover.