config: map mattermost-plugin-docs to its plugin ID - #98
Conversation
Without an entry the ID falls back to trimming the mattermost-plugin- prefix, giving "docs", but the Docs manifest declares "com.mattermost.docs". install-url succeeds either way since it takes a URL, so the Setup Cloud Test Server label produces a server with the plugin installed but not enabled.
|
@calebroseland: Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it. DetailsI understand the commands that are listed here |
📝 WalkthroughWalkthroughThe default configuration now maps ChangesPlugin repository mapping
Estimated code review effort: 1 (Trivial) | ~2 minutes Mergeability Score: 🔵 Low · up to The PR fixes Docs plugin ID resolution in the default configuration. It is mergeable with explicit owner follow-up to ensure any deployed configuration override includes the same mapping; otherwise Docs may be installed but remain disabled. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🔇 Additional comments (1)
config/config-matterwick.default.json (1)
73-73: 🗄️ Data Integrity & Integration
⚠️ Unverified finding
Sandbox verification was unavailable.Confirm that deployed configuration overrides include this mapping.
The value matches the
mmctl plugin enablelookup inserver/spinwick_plugin.go. If a deployed configuration overridesPluginRepoToIDMappinginstead of inheritingconfig/config-matterwick.default.json, add"mattermost-plugin-docs": "com.mattermost.docs"there as well. Otherwise, the fallback still derivesdocs.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 25a19266-1181-4324-81e2-78fd0c0329c8
📒 Files selected for processing (1)
config/config-matterwick.default.json
|
Closing — wrong target. |
Summary
Adds
mattermost-plugin-docs→com.mattermost.docstoPluginRepoToIDMapping, using the mechanism #78 introduced.Without an entry,
waitForAndInstallPluginfalls back to trimming themattermost-plugin-prefix:That yields
docs, but the Docs manifest declares"id": "com.mattermost.docs".install-urlsucceeds either way because it takes a URL, so the Setup Cloud Test Server label produces a test server with the plugin installed but not enabled — surfacing as the "Plugin Installation Issue / Enable Error" warning on the PR comment.Same shape as the
mattermost-plugin-boards→focalboardentry: a repo whose plugin ID isn't just its name minus the prefix.Context
The producer side is now in place on the Docs repo — mattermost-plugin-docs#20 adds the
distjob that uploadsmattermost-plugin-docs-<sha7>.tar.gzto the bucket matterwick polls, and the upload is confirmed working. Nothing else in matterwick needs changing:isPluginRepositoryalready matches bymattermost-plugin-prefix, the bucket is hardcoded to the one being written to, and theSetup Cloud Test Serverlabel already exists on that repo.Note for whoever deploys
This updates the in-repo default config only. If the deployed
config-matterwick.jsonsecret does not inherit from this file, it needs the same entry to take effect.Test plan
Apply Setup Cloud Test Server to a Docs PR and confirm the resulting comment reports the plugin as enabled rather than an Enable Error.
Release Note