Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mark Plugin Api as experimental #2743

Merged
merged 10 commits into from
Feb 24, 2023
Merged

Mark Plugin Api as experimental #2743

merged 10 commits into from
Feb 24, 2023

Conversation

vmishenev
Copy link
Member

IgnatBeresnev
IgnatBeresnev reviewed Nov 10, 2022
View reviewed changes
core/src/main/kotlin/plugability/DokkaPlugin.kt Show resolved Hide resolved
plugins/build.gradle.kts Outdated Show resolved Hide resolved
core/src/main/kotlin/plugability/DokkaPlugin.kt Outdated Show resolved Hide resolved
@IgnatBeresnev IgnatBeresnev linked an issue Nov 17, 2022 that may be closed by this pull request
Mark plugin API as Experimental/Unstable #2716
Closed
@vmishenev vmishenev force-pushed the 2716-mark-api-experimental branch 2 times, most recently from c2b53a3 to f63b0b8 Compare January 11, 2023 10:24
IgnatBeresnev
IgnatBeresnev reviewed Jan 12, 2023
View reviewed changes
plugins/build.gradle.kts Outdated Show resolved Hide resolved
core/src/main/kotlin/plugability/DokkaPlugin.kt Outdated Show resolved Hide resolved
@IgnatBeresnev
Copy link
Member

In case you missed it:

> Task :plugins:all-modules-page:compileTestKotlin FAILED
e: warnings found and -Werror specified
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\MultiModuleDokkaTestGenerator.kt: (21, 29): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\MultiModuleDokkaTestGenerator.kt: (21, 44): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\MultiModuleDokkaTestGenerator.kt: (26, 5): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\MultiModuleDokkaTestGenerator.kt: (26, 23): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\MultiModuleDokkaTestGenerator.kt: (32, 28): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\MultiModuleDokkaTestGenerator.kt: (32, 69): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\MultiModuleDokkaTestGenerator.kt: (32, 87): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\templates\MultiModuleDocumentationTest.kt: (42, 9): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\templates\ResolveLinkCommandResolutionTest.kt: (62, 9): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\templates\ResolveLinkCommandResolutionTest.kt: (91, 9): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\templates\ResolveLinkGfmCommandResolutionTest.kt: (57, 9): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.
w: D:\a\dokka\dokka\plugins\all-modules-page\src\test\kotlin\templates\ResolveLinkGfmCommandResolutionTest.kt: (57, 55): All of Dokka's plugin API is in preview and it can be changed in a backwards-incompatible manner with a best-effort migration. By opting in, you acknowledge the risks of relying on preview API.

FAILURE: Build completed with 2 failures.

1: Task failed with an exception.
-----------
* What went wrong:
Execution failed for task ':plugins:all-modules-page:compileTestKotlin'.
> A failure occurred while executing org.jetbrains.kotlin.compilerRunner.GradleCompilerRunnerWithWorkers$GradleKotlinCompilerWorkAction
   > Compilation error. See log for more details

@vmishenev vmishenev force-pushed the 2716-mark-api-experimental branch 5 times, most recently from 3439967 to 6734f09 Compare February 6, 2023 12:52
@vmishenev vmishenev force-pushed the 2716-mark-api-experimental branch 3 times, most recently from 754fcf0 to 56951a8 Compare February 7, 2023 23:47
IgnatBeresnev
IgnatBeresnev reviewed Feb 8, 2023
View reviewed changes
Copy link
Member

@IgnatBeresnev IgnatBeresnev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should check for backward compatibility as well in case you haven't. That is, what happens if a plugin that was written for Dokka 1.7.20 (an existing artifact) is used in conjunction with with Dokka 1.8.10

core/src/main/kotlin/plugability/DokkaPlugin.kt Outdated Show resolved Hide resolved
core/src/main/kotlin/plugability/DokkaPlugin.kt Outdated Show resolved Hide resolved
@vmishenev vmishenev merged commit b730bf4 into master Feb 24, 2023
@vmishenev vmishenev deleted the 2716-mark-api-experimental branch February 24, 2023 17:16
IgnatBeresnev pushed a commit that referenced this pull request Feb 27, 2023
@vmishenev @IgnatBeresnev
Mark Plugin Api as experimental (#2743)
5ccda6f 
(cherry picked from commit b730bf4)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qwwdfsad qwwdfsad qwwdfsad left review comments

@IgnatBeresnev IgnatBeresnev IgnatBeresnev approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Mark plugin API as Experimental/Unstable
3 participants
@vmishenev @IgnatBeresnev @qwwdfsad