Skip to content

Fix plugin verification docs: replace removed CLI commands#1501

Open
fmartingr wants to merge 4 commits intomasterfrom
fix/plugin-verification
Open

Fix plugin verification docs: replace removed CLI commands#1501
fmartingr wants to merge 4 commits intomasterfrom
fix/plugin-verification

Conversation

@fmartingr
Copy link
Copy Markdown
Contributor

@fmartingr fmartingr commented Apr 14, 2026

Summary

  • The "Plugin verification" section referenced legacy mattermost CLI commands (mattermost plugin add key, mattermost plugin keys, mattermost plugin delete key) that were removed in Mattermost v6.3.0 (commit 8f01a1b5a1, MM-36448: Removes legacy CLI commands).
  • These commands were never ported to mmctl — the current mmctl plugin subcommands (add, install-url, delete, enable, disable, list) do not include any key management functionality.
  • Replaced the non-existent CLI commands with the current method for managing plugin public keys: configuring PluginSettings.SignaturePublicKeyFiles in config.json.
  • Clarified that plugins are verified against both a hard-coded Mattermost public key and any admin-configured public keys (matching the actual behavior in server/channels/app/plugin_signature.go).

fmartingr and others added 2 commits April 14, 2026 12:00
…g instructions

The plugin key management CLI commands (mattermost plugin add key,
mattermost plugin keys, mattermost plugin delete key) were removed
in Mattermost v6.3.0 (commit 8f01a1b5a1, MM-36448) and were never
added to mmctl. The documentation also had incorrect syntax even
before removal (docs said "plugin add key" but actual command was
"plugin keys add").

Replace the non-existent CLI commands with the current method:
configuring PluginSettings.SignaturePublicKeyFiles in config.json.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 14, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 21d78e68-9ce0-4231-b41b-ffc25c79cb10

📥 Commits

Reviewing files that changed from the base of the PR and between 0fccd5e and 6e484e3.

📒 Files selected for processing (1)
  • site/content/integrate/plugins/using-and-managing-plugins.md
✅ Files skipped from review due to trivial changes (1)
  • site/content/integrate/plugins/using-and-managing-plugins.md

📝 Walkthrough

Walkthrough

Documentation replaced CLI-based plugin public key management with configuration-driven verification. Plugin signatures are verified against a built-in Mattermost public key plus any additional public keys listed in PluginSettings.SignaturePublicKeyFiles in config.json; key files must reside in the server config directory. (49 words)

Changes

Cohort / File(s) Summary
Plugin verification documentation
site/content/integrate/plugins/using-and-managing-plugins.md
Removed CLI mattermost plugin add key / list / delete instructions; changed wording from certificate-based trust to public-key usage; document verification now uses hard-coded Mattermost public key plus keys referenced by PluginSettings.SignaturePublicKeyFiles in config.json stored in the config directory.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main objective: fixing plugin verification documentation by replacing removed CLI commands with current configuration-based approach.
Description check ✅ Passed The description is directly related to the changeset, providing context about removed CLI commands, their replacement with config.json settings, and clarification of current plugin verification behaviour.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/plugin-verification

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

@github-actions
Copy link
Copy Markdown

Newest code from mattermost has been published to preview environment for Git SHA ad7306c

@github-actions
Copy link
Copy Markdown

Newest code from mattermost has been published to preview environment for Git SHA 0fccd5e

Copy link
Copy Markdown
Contributor

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

Updates the “Plugin verification” documentation to remove references to legacy mattermost plugin ... key(s) CLI commands (removed in Mattermost v6.3.0) and replaces them with the current configuration-based approach for adding plugin signature verification keys.

Changes:

  • Replaced removed legacy CLI key-management commands with PluginSettings.SignaturePublicKeyFiles configuration guidance.
  • Clarified that plugin verification checks both the built-in Mattermost key and any additional admin-configured keys.
  • Added a config.json snippet and note about where key files must be stored.

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

Comment thread site/content/integrate/plugins/using-and-managing-plugins.md
Comment thread site/content/integrate/plugins/using-and-managing-plugins.md
@fmartingr fmartingr self-assigned this Apr 16, 2026
@github-actions
Copy link
Copy Markdown

Newest code from mattermost has been published to preview environment for Git SHA 0fccd5e

fmartingr and others added 2 commits April 16, 2026 11:52
…ate'

The plugin signing section used 'public key certificate' and 'default
certificate', while the verification section used 'public key'. Since
the feature uses GPG (not X.509), 'public key' is the correct term.
This also matches the source code terminology in plugin_signature.go.
@github-actions
Copy link
Copy Markdown

Newest code from mattermost has been published to preview environment for Git SHA a77380f

@github-actions
Copy link
Copy Markdown

Newest code from mattermost has been published to preview environment for Git SHA 6e484e3

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