fix(installer): preserve stale installed modules during update by dickymoore · Pull Request #2391 · bmad-code-org/BMAD-METHOD

dickymoore · 2026-05-18T08:09:19Z

Summary

Fixes the update-time compatibility path for already-installed stale modules such as legacy Automator baut entries.

Changes

preserve installed modules whose source is no longer resolvable
preserve their config during modify/update and quick-update flows instead of dropping it or mis-scoping it

Why

This PR is about safe handling of existing installs. It prevents update flows from breaking or silently losing config when a previously installed module can no longer be resolved from current sources.

Scope limits

does not make Automator freshly installable again
does not add new module source resolution behavior
does not change registry metadata

Relationship To Other PRs

This PR is independent.

It solves the stale-install compatibility problem only. The separate “make Automator installable again” work is handled by:

BMAD-METHOD#2392 installer support for source_root
bmad-plugins-marketplace#26 registry metadata for Automator

Validation

node test/test-installation-components.js
full pre-commit suite passed during commit

dickymoore · 2026-05-18T08:53:36Z

Addressed on the latest branch tip in 1541840ec.

The retained-module config fix now preserves prior [modules.<code>] blocks verbatim when a module is being kept installed but its schema source can no longer be resolved. That avoids the remaining quick-update drift where user-scoped values could be rewritten from _bmad/config.user.toml into _bmad/config.toml.

Scope is still intentionally narrow:

fresh unknown-schema modules keep the existing fallback behavior and still get a normal [modules.*] section
only retained modules with an existing prior block take the verbatim-preservation path
no install-layout or source-resolution expansion was added

Validation: node test/test-installation-components.js and the full pre-commit test/lint/format suite passed on commit.

dickymoore · 2026-05-18T10:19:51Z

Cross-linking for review context:

This PR is the stale-install compatibility fix only.
It is independent of the fresh-installability work.
The separate “make Automator installable again” pair is:
- BMAD-METHOD#2392
- bmad-plugins-marketplace#26

Recommended merge order:

merge this PR independently
merge #26 and #2392 together, or #26 first and #2392 immediately after

github-actions · 2026-05-18T13:21:06Z

@coderabbitai review

augmentcode · 2026-05-18T13:26:30Z

🤖 Augment PR Summary

Summary: Improves update/quick-update safety for installs that contain modules whose source can no longer be resolved (e.g., legacy/stale modules), preventing them from being removed or having their config/skills silently dropped.

Changes:

Passes a _preserveModules list through the update flows and excludes those modules from deselection removal.
Reads the prior skill-manifest.csv before regeneration and re-appends preserved-module rows after manifest generation.
Tracks files under preserved modules so files-manifest.csv continues to reflect those installations.
Adjusts IDE cleanup/install flow detection to treat a provided previousSkillIds set as the install/update signal.
Adds UI logic to detect installed modules that are no longer in official/registry/custom sources and warns when they are retained.

Technical Notes: The installer now threads preserved-module context into both module removal and manifest/IDE cleanup so legacy modules stay installed and keep their recorded skill/config metadata during updates.

_{🤖 Was this summary useful? React with 👍 or 👎}

augmentcode

Review completed. 1 suggestion posted.

Comment augment review to trigger a new review at any time.

augmentcode · 2026-05-18T13:26:31Z

+    const preservedModuleSet = new Set(preservedModules || []);
+    const ids = new Set();
+    for (const row of previousRows || []) {
+      if (row.canonicalId && !preservedModuleSet.has(row.module)) {


In _getPreviousSkillIdsForCleanup, preservation depends on row.module being present in the previous skill-manifest.csv; if older manifests are missing the module column (or it’s blank), preserved-module skills could still be scheduled for cleanup. Consider a fallback derivation (e.g., from row.path) before comparing against preservedModules to make the stale-module compatibility path more robust.

Severity: medium

Other Locations

tools/installer/core/installer.js:455

_{🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.}

coderabbitai · 2026-05-18T13:27:18Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 78feb0cd-116d-450d-b8c1-e2b1a1c20d7f

📥 Commits

Reviewing files that changed from the base of the PR and between 0eae7c4 and 3cdee79.

📒 Files selected for processing (3)

tools/installer/core/installer.js
tools/installer/ide/_config-driven.js
tools/installer/ui.js

📝 Walkthrough

Walkthrough

The PR adds module preservation support to the installer's install/update flows. UI detects unselected installed modules lacking custom sources and marks them for preservation. The installer reads existing skill-manifest.csv before overwrite, excludes preserved modules from removal, tracks their files for manifest purposes, and re-appends their rows post-generation with deduping. IDE cleanup logic adjusts flow detection based on skill-ID truthiness.

Changes

Module Preservation During Install and Update

Layer / File(s)	Summary
UI module preservation detection `tools/installer/ui.js`	New `_retainUnavailableInstalledModules()` method identifies installed non-official modules to preserve when custom sources are unavailable. `promptInstall()` integrates this during update flow and includes `_preserveModules` in the return object.
Install entry point and skill-manifest reading `tools/installer/core/installer.js`	`install()` threads `originalConfig._preserveModules` through `_removeDeselectedModules()` and `_installAndConfigure()`. It reads existing `skill-manifest.csv` rows and computes prior skill IDs to clean up while excluding preserved modules, passing previous rows forward.
Configuration generation and manifest restoration `tools/installer/core/installer.js`	During configuration generation, preserved modules are tracked in installed files, module lists adjusted for manifest generation based on update vs full install, and preserved skill-manifest rows re-appended with CSV deduping. New helpers parse skill-manifest CSV, compute cleanup IDs, and append preserved rows with escaping.
IDE cleanup flow truthiness adjustment `tools/installer/ide/_config-driven.js`	Removal-set selection and `isInstallFlow` flag now check `previousSkillIds` truthiness instead of requiring non-empty set size, adjusting cleanup behavior when skill IDs are empty or present.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

bmad-code-org/BMAD-METHOD#2223: Both PRs modify the installer's update/skill-cleanup pipeline by reading and parsing existing _config/skill-manifest.csv to drive retention/removal decisions during install/quick-update flows.
bmad-code-org/BMAD-METHOD#2083: Both PRs modify manifest-generation CSV preservation logic; the main PR threads _preserveModules to retain skill-manifest rows while the retrieved PR removes earlier preservation logic.
bmad-code-org/BMAD-METHOD#2315: Both PRs extend installer cleanup/removal paths; the main PR preserves marked modules by canonicalId during update while the retrieved PR removes legacy pre-v6.2.0 wrapper skills.

Suggested reviewers

pbean
bmadcode
alexeyv

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: preserving stale installed modules during update operations, which is the core focus of the changeset.
Description check	✅ Passed	The description is directly related to the changeset, clearly explaining the problem being solved and the changes made to preserve stale modules during updates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

tools/installer/ide/_config-driven.js

Oops! Something went wrong! :(

ESLint: 9.39.4

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

tools/installer/core/installer.js

Oops! Something went wrong! :(

ESLint: 9.39.4

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

tools/installer/ui.js

Oops! Something went wrong! :(

ESLint: 9.39.4

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Documents the fix landed in #2391 and the manual step required for users who installed the experimental BMad Automator module under its previous `baut` code.

fix(installer): preserve stale installed modules on update

97f31f8

dickymoore mentioned this pull request May 18, 2026

fix(installer): restore automator install compatibility #2390

Closed

dickymoore added 5 commits May 18, 2026 09:27

test: drop stale baut regression case

3cf5f0b

fix(installer): preserve source-backed modules and configs

c11efd4

fix(installer): retain preserved module config in quick update

f0a22c2

fix(installer): preserve module config blocks for retained modules

313b999

fix(installer): preserve user-scope blocks for retained modules

1541840

dickymoore force-pushed the draft/preserve-stale-installed-modules branch from 76bf87c to 9cf7ba7 Compare May 18, 2026 12:19

fix(installer): retain stale modules during updates

3cdee79

dickymoore force-pushed the draft/preserve-stale-installed-modules branch from 9cf7ba7 to 3cdee79 Compare May 18, 2026 13:20

dickymoore marked this pull request as ready for review May 18, 2026 13:20

augmentcode Bot reviewed May 18, 2026

View reviewed changes

bmadcode merged commit a085226 into bmad-code-org:main May 18, 2026
6 checks passed

bmadcode mentioned this pull request May 18, 2026

docs(changelog): add v6.7.1 entry for installer stale-module fix #2393

Merged

1 task

bma-d mentioned this pull request May 18, 2026

fix: support legacy baut automator installs bmad-code-org/bmad-automator#15

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(installer): preserve stale installed modules during update#2391

fix(installer): preserve stale installed modules during update#2391
bmadcode merged 7 commits into
bmad-code-org:mainfrom
dickymoore:draft/preserve-stale-installed-modules

dickymoore commented May 18, 2026 •

edited

Loading

Uh oh!

dickymoore commented May 18, 2026

Uh oh!

dickymoore commented May 18, 2026

Uh oh!

github-actions Bot commented May 18, 2026

Uh oh!

augmentcode Bot commented May 18, 2026

Uh oh!

augmentcode Bot left a comment

Uh oh!

augmentcode Bot May 18, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 18, 2026

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

dickymoore commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Why

Scope limits

Relationship To Other PRs

Validation

Uh oh!

dickymoore commented May 18, 2026

Uh oh!

dickymoore commented May 18, 2026

Uh oh!

github-actions Bot commented May 18, 2026

Uh oh!

augmentcode Bot commented May 18, 2026

Uh oh!

augmentcode Bot left a comment

Choose a reason for hiding this comment

Uh oh!

augmentcode Bot May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot commented May 18, 2026

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dickymoore commented May 18, 2026 •

edited

Loading

augmentcode Bot May 18, 2026 •

edited

Loading