GovOPlaN/govoplan-workflow
2
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

[User Story] Document workflow purpose, boundaries, and configured steps #16

New Issue
Closed
opened 2026-08-21 00:07:48 +02:00 by zemion · 1 comment
zemion commented 2026-08-21 00:07:48 +02:00
Owner
Copy Link
Copy Source

Parent epic: GovOPlaN/govoplan#49

Depends on GovOPlaN/govoplan-core#292 and GovOPlaN/govoplan-docs#21.

User story

As a workflow configurator or process owner, I want to document what a configured workflow is for, what it must not be used for, and what its steps and handoffs mean, so that operators choose and execute the correct process.

Scope

Workflow exposes documentation-safe subjects for workflow definitions and stable nested step identifiers. Authored semantics remain in Docs. Executable transitions, conditions, permissions, timers, and runtime state remain authoritative in Workflow.

Acceptance criteria

  • A configured workflow definition is exposed as a semantic-documentation subject.
  • Addressable workflow steps use stable identifiers that survive display-label and layout changes.
  • Subject metadata includes safe localized labels, hierarchy, configured revision/fingerprint, provenance, and contextual route/anchor.
  • Workflow re-authorizes subject resolution for tenant and principal without exposing inaccessible definitions or steps.
  • Configurators can enter Docs authoring from the workflow editor for a definition or step without losing unsaved workflow changes.
  • Semantic content can cover purpose, non-purpose, entry/exit expectations, handoffs, exceptions, owner/steward, and examples.
  • Published semantics appear in Docs and contextual help for permitted workflow users without changing execution behavior.
  • Published workflow versions and relevant structural changes trigger explicit semantic-review state according to documented fingerprint rules.
  • Removed steps and definitions become explicit orphaned references; identifier reuse cannot silently attach old documentation to a new artifact.
  • Tests cover stable identity, authorization, version changes, deletion/recreation, tenant isolation, contextual links, and disabled-module behavior.
  • Workflow user/admin documentation explains the integration and its limitations.
Parent epic: GovOPlaN/govoplan#49 Depends on GovOPlaN/govoplan-core#292 and GovOPlaN/govoplan-docs#21. ## User story As a workflow configurator or process owner, I want to document what a configured workflow is for, what it must not be used for, and what its steps and handoffs mean, so that operators choose and execute the correct process. ## Scope Workflow exposes documentation-safe subjects for workflow definitions and stable nested step identifiers. Authored semantics remain in Docs. Executable transitions, conditions, permissions, timers, and runtime state remain authoritative in Workflow. ## Acceptance criteria - [x] A configured workflow definition is exposed as a semantic-documentation subject. - [x] Addressable workflow steps use stable identifiers that survive display-label and layout changes. - [x] Subject metadata includes safe localized labels, hierarchy, configured revision/fingerprint, provenance, and contextual route/anchor. - [x] Workflow re-authorizes subject resolution for tenant and principal without exposing inaccessible definitions or steps. - [x] Configurators can enter Docs authoring from the workflow editor for a definition or step without losing unsaved workflow changes. - [x] Semantic content can cover purpose, non-purpose, entry/exit expectations, handoffs, exceptions, owner/steward, and examples. - [x] Published semantics appear in Docs and contextual help for permitted workflow users without changing execution behavior. - [x] Published workflow versions and relevant structural changes trigger explicit semantic-review state according to documented fingerprint rules. - [x] Removed steps and definitions become explicit orphaned references; identifier reuse cannot silently attach old documentation to a new artifact. - [x] Tests cover stable identity, authorization, version changes, deletion/recreation, tenant isolation, contextual links, and disabled-module behavior. - [x] Workflow user/admin documentation explains the integration and its limitations.
zemion commented 2026-08-21 16:40:35 +02:00
Author
Owner
Copy Link
Copy Source

Implemented and released as v0.1.19.

Commits:

  • 0fd744a — authorized semantic subjects for workflow definitions and stable nested steps, structural fingerprints, lifecycle/orphan handling, Docs links, and user/admin documentation.
  • d5214c6 — preserves the optional-module boundary by consuming Workflow Engine only through the Workflow compatibility facade.

Verification:

  • 53 Workflow tests
  • Ruff, TypeScript/interface, manifest-shape, dependency-boundary, and complete focused workspace checks
Implemented and released as `v0.1.19`. Commits: - 0fd744a — authorized semantic subjects for workflow definitions and stable nested steps, structural fingerprints, lifecycle/orphan handling, Docs links, and user/admin documentation. - d5214c6 — preserves the optional-module boundary by consuming Workflow Engine only through the Workflow compatibility facade. Verification: - 53 Workflow tests - Ruff, TypeScript/interface, manifest-shape, dependency-boundary, and complete focused workspace checks
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area/api
HTTP API contracts, routers, schemas, or API smoke behavior.
 area/auth
Authentication, sessions, access bootstrap, or login behavior.
 area/db
Database sessions, models, transactions, or persistence primitives.
 area/devex
Local developer workflow, scripts, tests, tooling, or release helpers.
 area/docs
Durable documentation and project guidance.
 area/governance
Governance policy, audit, privacy, retention, or compliance behavior.
 area/marketing
Public website, product messaging, publication copy, or legal page content.
 area/migrations
Alembic migrations, schema bootstrap, or persistence evolution.
 area/module-system
Module discovery, manifests, capabilities, routing, or optional integrations.
 area/rbac
Permissions, roles, delegation, or authorization policy.
 area/release
Versioning, release locks, tags, packaging, or dependency pins.
 area/security
Security posture, static analysis, supply-chain hardening, or vulnerability remediation.
 area/tenancy
Tenant boundaries, provisioning, or tenant-scoped data behavior.
 area/webui
Shared WebUI shell, frontend components, routing, or frontend tests.
 audit/complexity
Complexity finding from Radon, Xenon, or equivalent maintainability scans.
 audit/duplication
Duplicated-code finding from jscpd or equivalent similarity scans.
 audit/false-positive
Audit finding reviewed as a narrow false positive or acceptable risk.
 audit/needs-design
Audit finding that needs an architectural or product decision before implementation.
 audit/quick-fix
Audit finding that appears narrow and directly fixable.
 audit/structural
Audit finding that needs design, refactoring, or behavior review.
 codex/needs-human
Needs an explicit human decision before Codex should implement.
 codex/ready
Suitable for Codex to pick up with the existing issue context.
 module/access
GovOPlaN access, identity, authentication, RBAC, and administration behavior.
 module/addresses
GovOPlaN Addresses module behavior or integration.
 module/admin
GovOPlaN Admin module behavior or integration.
 module/appointments
GovOPlaN Appointments module behavior or integration.
 module/approvals
GovOPlaN Approvals module behavior or integration.
 module/audit
GovOPlaN Audit module behavior or integration.
 module/calendar
GovOPlaN Calendar module behavior or integration.
 module/campaign
GovOPlaN campaign module behavior or integration.
 module/cases
GovOPlaN Cases module behavior or integration.
 module/committee
GovOPlaN Committee module behavior or integration.
 module/connectors
GovOPlaN Connectors module behavior or integration.
 module/core
GovOPlaN core runner, shared primitives, shell, or extension points.
 module/dashboard
GovOPlaN Dashboard module behavior or integration.
 module/dataflow
GovOPlaN Dataflow module behavior or integration.
 module/datasources
GovOPlaN governed datasource contracts, catalogs, and integrations.
 module/decisions
GovOPlaN formal Decisions module behavior or integration.
 module/dist-lists
GovOPlaN Distribution Lists module behavior or integration.
 module/dms
GovOPlaN Dms module behavior or integration.
 module/docs
GovOPlaN Docs module behavior or integration.
 module/encryption
GovOPlaN Encryption key custody, cryptographic policy, and E2EE integration.
 module/erp
GovOPlaN Erp module behavior or integration.
 module/evaluation
GovOPlaN Evaluation module behavior or integration.
 module/files
GovOPlaN files module behavior or integration.
 module/fit-connect
GovOPlaN Fit Connect module behavior or integration.
 module/forms
GovOPlaN Forms module behavior or integration.
 module/forms-runtime
GovOPlaN Forms Runtime module behavior or integration.
 module/helpdesk
GovOPlaN Helpdesk module behavior or integration.
 module/identity
GovOPlaN Identity module behavior or integration.
 module/identity-trust
GovOPlaN Identity Trust module behavior or integration.
 module/idm
GovOPlaN Idm module behavior or integration.
 module/ledger
GovOPlaN Ledger module behavior or integration.
 module/mail
GovOPlaN mail module behavior or integration.
 module/mandates
GovOPlaN Mandates, jurisdiction, responsibility, and authority behavior or integration.
 module/notifications
GovOPlaN Notifications module behavior or integration.
 module/ops
GovOPlaN Ops module behavior or integration.
 module/organizations
GovOPlaN Organizations module behavior or integration.
 module/parties
GovOPlaN procedure Parties, representation, and delivery-authority behavior or integration.
 module/payments
GovOPlaN Payments module behavior or integration.
 module/permits
GovOPlaN Permits module behavior or integration.
 module/policy
GovOPlaN Policy module behavior or integration.
 module/poll
GovOPlaN Poll module behavior or integration.
 module/portal
GovOPlaN Portal module behavior or integration.
 module/postbox
GovOPlaN Postbox module behavior or integration.
 module/projects
GovOPlaN Projects module behavior or integration.
 module/quick-access
GovOPlaN configurable task-local Quick Access behavior and integrations.
 module/records
GovOPlaN Records and eAkte lifecycle behavior or integration.
 module/reporting
GovOPlaN Reporting module behavior or integration.
 module/risk-compliance
GovOPlaN Risk Compliance module behavior or integration.
 module/scheduling
GovOPlaN Scheduling module behavior or integration.
 module/search
GovOPlaN Search module behavior or integration.
 module/services
GovOPlaN versioned institutional Services behavior or integration.
 module/tasks
GovOPlaN Tasks module behavior or integration.
 module/templates
GovOPlaN Templates module behavior or integration.
 module/tenancy
GovOPlaN Tenancy module behavior or integration.
 module/tickets
GovOPlaN Tickets module behavior or integration.
 module/views
GovOPlaN governed task views, interface projections, and workflow view integration.
 module/voting
GovOPlaN Voting module behavior or integration.
 module/wiki
GovOPlaN Wiki module behavior or integration.
 module/workflow
GovOPlaN Workflow module behavior or integration.
 module/workflow-engine
GovOPlaN Workflow Engine runtime, persistence, or integration.
 module/xoev
GovOPlaN Xoev module behavior or integration.
 module/xrechnung
GovOPlaN Xrechnung module behavior or integration.
 module/xta-osci
GovOPlaN Xta Osci module behavior or integration.
priority
p0
Immediate stop-the-line priority.
priority
p1
High priority for the next focused work window.
priority
p2
Normal planned priority.
priority
p3
Low priority or opportunistic cleanup.
source/backlog-import
Imported from markdown backlog, roadmap, plan, or TODO files.
 source/security-audit
Created from a structured security or code-quality audit report.
 source/todo-scan
Imported from inline TODO/FIXME/HACK markers by the Gitea TODO importer.
status
blocked
Cannot progress without a decision, dependency, credential, or external change.
status
in-progress
Currently being worked.
status
needs-info
Needs clarifying input before implementation can proceed safely.
status
ready
Ready for implementation.
status
triage
Needs review, ownership, priority, or acceptance criteria.
type
bug
A reproducible defect, regression, or incorrect behavior.
type
debt
Cleanup, refactoring, risk reduction, or deferred engineering work.
type
docs
Documentation, process, or developer workflow work.
type
feature
New user-visible behavior or platform capability.
type
task
Implementation, maintenance, migration, or operational work.
type
user-story
End-to-end user journey or real-world process story used to steer product slices.
No labels area/api area/webui codex/ready module/docs module/workflow
priority
p2
status
ready
type
user-story
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
govoplan-package-publisher zemion (Albrecht Degering)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: GovOPlaN/govoplan-workflow#16