Mark paper-plugin.yml as experimental #2122
Merged
Conversation
This file contains 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
lynxplay
force-pushed
the
enhancement/mark-paper-plugins-as-experimental
branch
from
193ba10 to
1d8cd79
Compare
|
Resolved formatting issue. |
Leguan16
reviewed
Oct 7, 2023
While paper plugins and their respective loading strategy have been integrated into paper for a while now, the developer facing side of paper plugins is still highly experimental. Specifically the paper-plugin.yml file structure is still under active development and its syntax might change without a deprecation cycle. Its usage for general purpose plugin development is still hence discouraged. While developers that are familiar with the caveats of using paper plugins but decide to do so anyway due to the already existing features exist, this commit still adds a warning to ensure that developers not familiar with the system do not accidentally use it for new projects, preventing frustration down the line with potential missing features or breaking changes over the usage of a plain plugin.yml file.
lynxplay
force-pushed
the
enhancement/mark-paper-plugins-as-experimental
branch
from
1d8cd79 to
a81e7a8
Compare
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.
While paper plugins and their respective loading strategy have been integrated into paper for a while now, the developer facing side of paper plugins is still highly experimental.
Specifically the paper-plugin.yml file structure is still under active development and its syntax might change without a deprecation cycle. Its usage for general purpose plugin development is still hence discouraged.
While developers that are familiar with the caveats of using paper plugins but decide to do so anyway due to the already existing features exist, this commit still adds a warning to ensure that developers not familiar with the system do not accidentally use it for new projects, preventing frustration down the line with potential missing features or breaking changes over the usage of a plain plugin.yml file.