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.

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

Versioning plugin + Dokka v2 Gradle plugin false .DS_Store warning #3963

Open
jeffdgr8 opened this issue Dec 19, 2024 · 1 comment · May be fixed by #3973
Open

Versioning plugin + Dokka v2 Gradle plugin false .DS_Store warning #3963

jeffdgr8 opened this issue Dec 19, 2024 · 1 comment · May be fixed by #3973
Labels
bug runner: gradle plugin v2 Issues fixed by Dokka Gradle Plugin v2 - see https://github.com/Kotlin/dokka/issues/3131

Comments

@jeffdgr8
Copy link

Describe the bug
Using the versioning plugin with the Dokka v2 Gradle plugin produces the warning:

[:dokkaGeneratePublicationHtml] Failed to find versions file named version.json in /{olderVersionsDir}/.DS_Store

Expected behaviour
No warning should be output. .DS_Store (and probably any non-directory file) should be ignored.

To Reproduce
Run the :dokkaGenerate task with a .DS_Store file in the olderVersionsDir directory.

Dokka configuration
Configuration of dokka used to reproduce the bug

dependencies {
    dokkaPlugin(libs.dokka.versioning)
}

tasks.dokkaGeneratePublicationHtml {
    dokka.pluginsConfiguration.versioning {
        olderVersionsDir = projectDir.resolve("docs/older")
        // ...
    }
}

Installation

  • Operating system: macOS
  • Build tool: Gradle v8.11.1
  • Dokka version: 2.0.0

Additional context
Reproducible with my library, Kotbase.

@jeffdgr8 jeffdgr8 added the bug label Dec 19, 2024
@whyoleg whyoleg added plugin: versioning An issue/PR related to Dokka's versioning plugin runner: gradle plugin v2 Issues fixed by Dokka Gradle Plugin v2 - see https://github.com/Kotlin/dokka/issues/3131 and removed plugin: versioning An issue/PR related to Dokka's versioning plugin labels Dec 19, 2024
@jeffdgr8
Copy link
Author

Fixed in #3973

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug runner: gradle plugin v2 Issues fixed by Dokka Gradle Plugin v2 - see https://github.com/Kotlin/dokka/issues/3131
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants