docs: add a guide for testing a custom driver plugin locally#1761
Open
mvanhorn wants to merge 1 commit into
Open
docs: add a guide for testing a custom driver plugin locally#1761mvanhorn wants to merge 1 commit into
mvanhorn wants to merge 1 commit into
Conversation
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a Development docs page,
Testing a Custom Plugin, covering how to run and test a third-party driver plugin in a local debug build.Why
In #1747 a plugin author wrote their own driver and hit a code signing error ("Unable to install plug-in") when trying to package and install it like a registry plugin. The maintainer answered with the workflow but it wasn't documented anywhere: the existing Development pages cover
building,architecture, andplugin-registry, but none explain how to develop and locally test a brand-new plugin without hitting the signing wall.Changes
docs/development/testing-plugins.mdx: add the plugin to the Copy Plug-Ins build phase of the TablePro target,Cmd+Rto run and test, then remove it from Copy Plug-Ins for a clean release build. Includes a short explanation of why the signing error happens (registry plugins are signed and verified; a locally-built plugin runs under the debug build's signature). Links to the existing Building and Plugin Registry pages rather than duplicating their content.docs/docs.json: register the page in the Development group, right afterdevelopment/plugin-registry.Docs-only change. No code or CHANGELOG entry per the docs-only rule.
Fixes #1747