Skip to content

Reconcile 15.1.1 execplan: audit and align workspace#525

Closed
leynos wants to merge 1 commit intomainfrom
formal-verification-workspace-setup-4j8vyz
Closed

Reconcile 15.1.1 execplan: audit and align workspace#525
leynos wants to merge 1 commit intomainfrom
formal-verification-workspace-setup-4j8vyz

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Apr 17, 2026

Summary

  • Introduces a reconciliatio­n plan to align the current repo state with roadmap item 15.1.1 for a hybrid workspace root manifest.
  • Emphasizes audit-first approach and preserves existing root metadata, default-members, and staged roadmap boundaries.
  • No code changes are made yet; the plan governs documentation updates and validation evidence before any implementation edits.

Changes

  • Added a new ExecPlan document: docs/execplans/15-1-1-convert-root-manifest-into-hybrid-workspace.md (new file generated by this work).
  • The PR captures the audit-forward approach, acceptance criteria, risks, and a staged plan to align numbering and documentation.

Plan of work (Stage A–E)

Stage A: reconcile the current state

  • Audit Cargo.toml, docs/roadmap.md, docs/formal-verification-methods-in-wireframe.md, docs/developers-guide.md, and the existing 10-1-1 execplan to determine what 15.1.1 already satisfies.
  • Record findings in the ExecPlan and decide if only numbering drift remains.
  • Do not alter the workspace layout at this stage unless required by audit.

Stage B: align documentation to current roadmap numbering

  • Update references in docs/formal-verification-methods-in-wireframe.md and docs/developers-guide.md from 10.1.x to 15.1.x where applicable.
  • Preserve the staged boundary: 15.1.1 remains the hybrid workspace, 15.1.2 adds crates/wireframe-verification.
  • If helpful, add archival notes to the old 10-1-1 execplan to reflect renumbering history.

Stage C: correct any real acceptance gap (only if audit proves one)

  • If gaps exist, implement minimal changes that do not introduce new verification tooling or workspace members.
  • Prohibit creating crates/wireframe-verification or expanding CI targets unless necessary.

Stage D: validate the result and capture evidence

  • Run acceptance commands from the repo root
    • cargo metadata --no-deps --format-version 1 | tee /tmp/15-1-1-cargo-metadata.log
    • cargo build | tee /tmp/15-1-1-cargo-build.log
    • cargo test --workspace | tee /tmp/15-1-1-cargo-test-workspace.log
  • If tests or docs change, run focused workspace-contract tests and markdown/docs checks as described in the plan.
  • Record all outcomes and any environment-limited failures.

Stage E: close the plan cleanly

  • Update Progress, Surprises & Discoveries, Decision Log, and Outcomes & Retrospective in the ExecPlan.
  • Ensure docs/roadmap.md remains correct as [x] if the audit confirms completion.

Validation / Acceptance criteria

Observable success includes:

  1. Cargo metadata/build/test pass from repository root.
  2. The root manifest remains the sole default-members entry and hybrid workspace configuration is preserved.
  3. Existing rstest and rstest-bdd coverage remains valid; no redundant tests are added unless gaps are found.
  4. Documentation references reflect current 15.1.1/15.1.2 numbering where applicable.
  5. No consumer-facing changes unless audit finds a real impact.
  6. The execplan status is updated accordingly if changes are made.

Risks & mitigations

  • Risk: renumbering could duplicate history or overwrite evidence. Mitigation: preserve 10-1-1 as historical record and use 15-1-1 as the current approval gate.
  • Risk: references may slip between docs. Mitigation: audit and correct all stale 10.1.x references to 15.1.x where appropriate.
  • Risk: accidental drift into 15.1.2. Mitigation: keep staged boundary explicit and stop if boundary is threatened.

How to review

  • Review the new execplan for completeness and alignment with existing repo state.
  • Confirm that the audit-focused approach and staged plan align with project governance.
  • Provide approval or requested changes to tighten references or update guidance.

Next steps after approval

  • Implement the smallest documentation changes required by Stage B, and add or adjust validation evidence as described in Stage D.
  • Do not modify Cargo/workspace structure until explicit approval is granted for implementation edits.

◳ Generated by DevBoxer


ℹ️ Tag @devboxerhub to ask questions and address PR feedback

📎 Task: https://www.devboxer.com/task/815e038d-2552-42cb-b213-b2d28f221c6b

Summary by Sourcery

Documentation:

  • Add a detailed execplan for roadmap item 15.1.1 that documents constraints, risks, staged work plan, validation steps, and closure criteria for converting and reconciling the root manifest as a hybrid workspace.

… item 15.1.1

Add a detailed execution plan for roadmap item 15.1.1 that reconciles the
existing workspace hybrid manifest with the new numbering scheme. This living
document establishes audit criteria, approval gates, constraints, and staged
work boundaries, preserving the earlier implementation record under roadmap
item 10.1.1. It serves as an approval gate and reference for minimal changes,
keeping the root workspace manifest and documentation aligned with current
roadmap numbering.

Co-authored-by: devboxerhub[bot] <devboxerhub[bot]@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 17, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 2d2f3ed2-b3b4-4e2a-9484-e7ea781ae653

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch formal-verification-workspace-setup-4j8vyz

Comment @coderabbitai help to get the list of available commands and usage tips.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Apr 17, 2026

Reviewer's Guide

Adds a new execplan document for roadmap item 15.1.1 that defines an audit-first reconciliation and documentation-alignment plan for the existing hybrid workspace root manifest, including staged work, constraints, risks, and validation steps, but makes no code or configuration changes yet.

Sequence diagram for Stage D validation commands

sequenceDiagram
  actor Contributor
  participant Execplan15_1_1
  participant Shell
  participant Cargo
  participant Makefile
  participant Filesystem

  Contributor->>Execplan15_1_1: Read Stage_D_validation_steps
  Contributor->>Shell: Run cargo metadata with pipefail and tee
  Shell->>Cargo: Execute cargo metadata --no-deps --format-version 1
  Cargo-->>Shell: Metadata JSON output
  Shell->>Filesystem: Write /tmp/15-1-1-cargo-metadata.log

  Contributor->>Shell: Run cargo build with pipefail and tee
  Shell->>Cargo: Execute cargo build
  Cargo-->>Shell: Build output and status
  Shell->>Filesystem: Write /tmp/15-1-1-cargo-build.log

  Contributor->>Shell: Run cargo test --workspace with pipefail and tee
  Shell->>Cargo: Execute cargo test --workspace
  Cargo-->>Shell: Test results
  Shell->>Filesystem: Write /tmp/15-1-1-cargo-test-workspace.log

  alt Tests_or_docs_changed
    Contributor->>Shell: Run focused workspace_manifest tests
    Shell->>Cargo: Execute cargo test commands for workspace_manifest
    Cargo-->>Shell: Focused test results
    Shell->>Filesystem: Write focused test logs

    Contributor->>Shell: Run make fmt, markdownlint, nixie
    Shell->>Makefile: Execute documentation make targets
    Makefile-->>Shell: Gate results
    Shell->>Filesystem: Write documentation gate logs
  end

  alt Rust_code_or_tests_changed
    Contributor->>Shell: Run make check-fmt, lint, test
    Shell->>Makefile: Execute code quality gates
    Makefile-->>Shell: Gate results
    Shell->>Filesystem: Write quality gate logs
  end

  Contributor->>Execplan15_1_1: Record outcomes and any environment-limited failures
Loading

Flow diagram for Stage A–E execplan workflow

flowchart TD
  Start[Start: roadmap item 15.1.1 marked done but needs reconciliation] --> DraftExecplan[Draft execplan 15_1_1 and obtain approval]

  DraftExecplan --> ApprovalGate{Execplan approved?}
  ApprovalGate -- No --> StopNoApproval[Stop: do not change code or docs]
  ApprovalGate -- Yes --> StageA[Stage A: Audit current tree]

  StageA --> AuditOutcome{Only numbering drift?}
  AuditOutcome -- Yes --> ScopeDocsOnly[Scope: docs and evidence only]
  ScopeDocsOnly --> StageB[Stage B: Align documentation numbering]

  AuditOutcome -- No, real gap --> StageC[Stage C: Correct acceptance gap]

  StageB --> StageD[Stage D: Run validation commands and docs/tests gates]
  StageC --> StageD

  StageD --> ValidationOutcome{Validation passes?}
  ValidationOutcome -- No --> RecordFailures[Record environment or baseline failures and escalate]
  RecordFailures --> StageE[Stage E: Close plan with outcomes and retrospective]

  ValidationOutcome -- Yes --> StageE

  StageE --> End[End: roadmap 15.1.1 remains correctly marked done]
Loading

File-Level Changes

Change Details Files
Introduce an execplan document that formalizes an audit-first, staged reconciliation plan for roadmap item 15.1.1 without changing code or workspace configuration.
  • Create a new execplan markdown file describing the purpose and scope of reconciling roadmap item 15.1.1 with the already implemented hybrid workspace layout.
  • Document constraints, tolerances, and risks to preserve the current workspace shape, numbering boundaries, and existing validation practices.
  • Lay out staged work (Stages A–E) covering audit of current state, documentation renumbering, minimal corrective changes if needed, validation commands and evidence capture, and clean plan closure.
  • Define observable acceptance criteria and required validation commands (cargo and Makefile targets) along with logging conventions for evidence.
  • Record initial progress, discoveries about current repo state, and decisions that frame this as a reconciliation/renumbering task rather than a fresh implementation.
docs/execplans/15-1-1-convert-root-manifest-into-hybrid-workspace.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@leynos leynos closed this Apr 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant