Skip to content

P1-T13: Document stale editable install version mismatch in troubleshooting guide#166

Merged
SoundBlaster merged 10 commits intomainfrom
feature/P1-T13-stale-editable-install-troubleshooting
Mar 10, 2026
Merged

P1-T13: Document stale editable install version mismatch in troubleshooting guide#166
SoundBlaster merged 10 commits intomainfrom
feature/P1-T13-stale-editable-install-troubleshooting

Conversation

@SoundBlaster
Copy link
Owner

Description

  • Complete FLOW for P1-T13 and archive the task after rebasing onto current main.
  • Document the stale editable-install version mismatch scenario in docs/troubleshooting.md and sync the DocC mirror.
  • Include the archived validation report with updated post-rebase quality gate results.

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactoring
  • CI/CD improvement

Quality Gates

Before submitting, ensure all quality gates pass:

make check

Or run individually:

  • make test - All tests pass with ≥90% coverage
  • make lint - No linting errors
  • make format - Code is properly formatted
  • make typecheck - Type checking passes
  • make doccheck - Documentation is synced with DocC (if docs changed)

Quality gate results:

  • pytest — PASS (902 passed, 5 skipped, 2 warnings)
  • pytest --cov — PASS (91.55% total coverage)
  • ruff check src/ — PASS
  • mypy src/ — PASS
  • make doccheck-all — PASS

Documentation Sync

If you modified files in docs/, ensure corresponding DocC files are also updated:

docs/ file DocC file
docs/installation.md mcpbridge-wrapper.docc/Installation.md
docs/cursor-setup.md mcpbridge-wrapper.docc/CursorSetup.md
docs/claude-setup.md mcpbridge-wrapper.docc/ClaudeCodeSetup.md
docs/codex-setup.md mcpbridge-wrapper.docc/CodexCLISetup.md
docs/troubleshooting.md mcpbridge-wrapper.docc/Troubleshooting.md
docs/architecture.md mcpbridge-wrapper.docc/Architecture.md
docs/environment-variables.md mcpbridge-wrapper.docc/EnvironmentVariables.md
README.md mcpbridge-wrapper.docc/mcpbridge-wrapper.md
  • Documentation changes are synced with DocC catalog (or N/A)

Testing

  • Added/updated tests for new functionality
  • All tests pass locally
  • Manually tested the changes

Checklist

  • Code follows the project's style guidelines
  • Self-review completed
  • Comments added for complex code
  • Documentation updated (if needed)
  • No new warnings generated
  • PR title is descriptive

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR documents a common local-development failure mode where an editable install’s dist-info version becomes stale after bumping pyproject.toml, causing mcpbridge-wrapper --doctor to report a package/broker version mismatch, and it archives the completed task artifacts for P1‑T13.

Changes:

  • Adds a new troubleshooting entry (and DocC mirror) explaining the stale editable-install version metadata and the fix (pip install -e .).
  • Archives P1‑T13 workflow artifacts (PRD, validation report, review report) and updates Workplan/next/archive index bookkeeping.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
SPECS/Workplan.md Adds completed task entry for P1‑T13 in the workplan.
SPECS/INPROGRESS/next.md Records P1‑T13 as recently archived.
SPECS/ARCHIVE/P1-T13_Document_stale_editable_install_version_mismatch_in_troubleshooting_guide/P1-T13_Validation_Report.md Adds validation report for the task.
SPECS/ARCHIVE/P1-T13_Document_stale_editable_install_version_mismatch_in_troubleshooting_guide/P1-T13_Document_stale_editable_install_version_mismatch_in_troubleshooting_guide.md Adds archived PRD for the task.
SPECS/ARCHIVE/INDEX.md Adds P1‑T13 entries to archive index and log.
SPECS/ARCHIVE/_Historical/REVIEW_p1_t13_editable_install_troubleshooting.md Adds historical review report artifact for P1‑T13.
Sources/XcodeMCPWrapper/Documentation.docc/Troubleshooting.md Adds DocC troubleshooting section for stale editable-install version mismatch.
docs/troubleshooting.md Adds end-user troubleshooting entry (developer-scoped) describing symptom/cause/fix.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@SoundBlaster SoundBlaster merged commit 4165959 into main Mar 10, 2026
10 checks passed
@SoundBlaster SoundBlaster deleted the feature/P1-T13-stale-editable-install-troubleshooting branch March 10, 2026 00:03
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.

2 participants