chore: post-v0.4.0 audit + light cleanup - #1
Merged
Conversation
Read-only audit across 8 dimensions (git/version/PyPI/release/pro/ artifacts/docs/roadmap) — 3 PASS, 5 WARN, 0 FAIL. Report at `docs/projet-file/audit-post-v0.4.0.md` (allowlisted via gitignore `audit-*.md` pattern). Phase 2 fixes applied (doc-only, zero src/test changes, 394 passed / 24 skipped before+after, ruff clean) : - CHANGELOG: `[0.4.0]` heading gains the 2026-05-15 release date ; fresh empty `[Unreleased]` heading inserted above for the next sprint ; link references updated (`[Unreleased]` now compares from `v0.4.0...HEAD` ; new `[0.4.0]: v0.3.0...v0.4.0` reference). - README.md:182 "all 9 tools" → "all 11 tools" (mock backend count). - pr-body-draft.md removed from working tree (v0.4.0 ship residue, was untracked, never committed). Out of scope — deferred to v0.5.0 sprint : - README.md:174 DDS tool table expansion (`participant_events`, `topic_metrics`, `peek_bag_samples`) → sub-milestone 5.1. - docs/DDS_QUICKSTART.md §4 single-adapter limitation rewrite (lifted by v0.4.0 Phase 1 Composite adapter) → sub-milestone 5.2. - docs/TESTING.md "five MCP tools" wording refresh → sub-milestone 5.2. - audit-followup-triage-v0.2.0.md status refresh (A4/B6/B9 closed but not marked) → sub-milestone 5.3. - GitHub release v0.4.0 body — currently title-only ; full cumulative recap available in CHANGELOG, editable post-hoc via `gh release edit` (marketing surface, deliberately not touched). No version bump, no tag, no production code touched, no force push.
There was a problem hiding this comment.
Pull request overview
Documentation-only post-release audit and small housekeeping updates following the v0.4.0 ship, intended to capture the audit findings in-repo and align a few release/docs artifacts without touching runtime code or tests.
Changes:
- Added a post-v0.4.0 audit report under
docs/projet-file/. - Restored an empty
[Unreleased]section in the changelog, added the v0.4.0 release date, and corrected link references. - Updated README wording for the mock-backend tool count.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Updates documentation around composite adapter/mock backend tool count. |
| docs/projet-file/audit-post-v0.4.0.md | Adds a tracked post-release audit report documenting PASS/WARN items and deferred follow-ups. |
| CHANGELOG.md | Restores [Unreleased], adds v0.4.0 date, and fixes compare link references. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `peek_dds_samples` | Recent samples on a raw DDS topic (distinct from `sample_messages` on ROS2 graph)| | ||
|
|
||
| **Composite adapter (v0.4.0 Phase 1+).** When `TOPICFORGE_MODE=live` is paired with a DDS backend (`cyclone`, `fast`, …), TopicForge instantiates **both** a ROS2 CLI adapter and the chosen DDS adapter and routes per-tool category — the 5 ROS2 tools hit the CLI, the 3 DDS tools (+ `participant_events` from Phase 1) hit the DDS backend. ROS2-only or DDS-only setups still work — the missing half is skipped and the present half serves what it can. The mock backend continues to expose all 9 tools against deterministic fixtures for local development. | ||
| **Composite adapter (v0.4.0 Phase 1+).** When `TOPICFORGE_MODE=live` is paired with a DDS backend (`cyclone`, `fast`, …), TopicForge instantiates **both** a ROS2 CLI adapter and the chosen DDS adapter and routes per-tool category — the 5 ROS2 tools hit the CLI, the 3 DDS tools (+ `participant_events` from Phase 1) hit the DDS backend. ROS2-only or DDS-only setups still work — the missing half is skipped and the present half serves what it can. The mock backend continues to expose all 11 tools against deterministic fixtures for local development. |
| | 5 | `pro/` folder integrity | PASS | 0 files committed, 15 files on disk, gitignore line 226 active | | ||
| | 6 | Dev artifacts | WARN | `pr-body-draft.md` untracked at repo root — residue from ship session | | ||
| | 7 | Doc consistency | WARN | Tool count drift (5 / 9 / 11 used inconsistently) ; DDS_QUICKSTART §4 describes a v0.3.0 limitation lifted by v0.4.0 Phase 1 | | ||
| | 8 | TODO(roadmap) + audit triage | WARN | 7 markers, all legitimately forward-looking ; v0.2.0 triage doc not refreshed (B6/B9/A4 closed but unmarked) | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
pro/, dev artifacts, docs consistency, roadmap markers) post-v0.4.0 ship. Report atdocs/projet-file/audit-post-v0.4.0.md(allowlisted byaudit-*.mdgitignore pattern). Verdict: 3 PASS, 5 WARN, 0 FAIL — zero functional regression.src/topicforge/touch): CHANGELOG[0.4.0]gets its2026-05-15date and a fresh empty[Unreleased]heading is restored ; link references aligned ; README mock-backend count fix9 → 11;pr-body-draft.mdv0.4.0-ship residue dropped.What's not in this PR (handed off to v0.5.0)
participant_events,topic_metrics,peek_bag_samples; refresh telemetry contract docs at line 271.docs/DDS_QUICKSTART.md §4(single-adapter limitation no longer applies post Phase 1 Composite) and §5 (XTypes scope) ; refreshdocs/TESTING.md"five tools" wording in three places.docs/projet-file/audit-followup-triage-v0.2.0.md: A4 / B6 / B9 are closed but unmarked ; re-walk B1-B10 against the v0.4.0 tree.gh release editafter this lands (marketing copy, deliberately deferred).Constraints respected
pyproject.tomlversion stays"0.4.0",__version__stays"0.4.0", no tag created, no force push.git ls-tree -r HEAD --name-only | findstr "^pro/"returns empty — pro tier scaffold untouched.src/topicforge/and zero changes undertests/.Test plan
python -m ruff check src testscleanpython -m pytest→ 394 passed, 24 skipped (same as v0.4.0 baseline)git ls-tree -r HEAD --name-only | findstr "^pro/"returns emptygit check-ignore -v docs/projet-file/audit-post-v0.4.0.md→ allowlist line 214 confirms tracked