Skip to content

Docs: Migration guide pins v0.8.18 — should reference latest or @latest #320

Closed

Description

@uvirk

Problem

The migration guide hard-codes @0.8.18 throughout, which leads users to install an outdated version that is missing critical fixes (e.g., the Node 24+ ESM compatibility fix shipped in v0.8.23).

Current latest release is v0.8.25.

Affected Sections

The following all explicitly reference 0.8.18:

  • Quick Reference table — shows v0.8.18 as the "After" version
  • Scenario 2 (Upgrading from v0.5.4 Beta), Step 3:
    npm install -g @bradygaster/squad-cli@0.8.18
  • Scenario 3 (Already on v0.8.x) — Expected output: 0.8.18
  • Scenario 8 (CI/CD) — pins @0.8.18 in workflow examples
  • "What's New in v0.8.18" section heading in the TOC

Impact

Users following the migration guide install v0.8.18, which crashes on Node 24+ with:

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '...vscode-jsonrpc/node'

This was fixed in v0.8.23 but the docs send users to the broken version.

Suggested Fix

  • Replace pinned @0.8.18 references with @latest (or at minimum @0.8.25)
  • For CI/CD pinning advice, recommend pinning to the current latest rather than hard-coding 0.8.18
  • Update the Quick Reference table and TOC to reflect the current version

Activity

  1. bradygaster commented on Mar 10, 2026

    @bradygaster
    Collaborator

    Triage: Migration guide pins v0.8.18 — outdated, sends users to broken version. Should reference @latest or v0.8.25+. P1 — docs quality & correctness. @pao + @Surgeon to coordinate.

  2. github-actions commented on Mar 10, 2026

    @github-actions
    Contributor

    📋 Assigned to PAO (DevRel)

    Issue: #320 — Docs: Migration guide pins v0.8.18 — should reference latest or @latest

    PAO will pick this up in the next Copilot session.

    For Copilot coding agent: If enabled, this issue will be worked automatically.
    Otherwise, start a Copilot session and say:
    PAO, work on issue #320

  3. bradygaster commented on Mar 10, 2026

    @bradygaster
    Collaborator

    Triage by PAO

    The migration guide hard-codes v0.8.18 throughout—users following it install an outdated version missing Node 24+ compatibility fixes (shipped in v0.8.23, current is v0.8.25).

    Affected sections:

    • Quick Reference table
    • Scenario 2 (upgrading from v0.5.4): pins @0.8.18
    • Scenario 3 (already on v0.8.x): expects 0.8.18
    • Scenario 8 (CI/CD): workflow example pins @0.8.18
    • TOC heading references v0.8.18

    Fix needed:
    Replace hard-coded v0.8.18 references with @latest (or @0.8.25 minimum). For CI/CD advice, recommend versioning to current latest rather than a fixed old version.

    This is P1 — blocks users on current Node versions.

  4. github-actions commented on Mar 13, 2026

    @github-actions
    Contributor

    📋 Assigned to PAO (DevRel)

    Issue: #320 — Docs: Migration guide pins v0.8.18 — should reference latest or @latest

    PAO will pick this up in the next Copilot session.

    For Copilot coding agent: If enabled, this issue will be worked automatically.
    Otherwise, start a Copilot session and say:
    PAO, work on issue #320

  5. added a commit that references this issue on Mar 16, 2026
    21a46b8
  6. deleted a comment from github-actions on Mar 18, 2026
  7. added a commit that references this issue on Mar 19, 2026
  8. added a commit that references this issue on Mar 20, 2026
  9. added a commit that references this issue on Mar 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions