Skip to content

Default description is the project name #39

@Hansanto

Description

@Hansanto

Context

Hello

Based on the documentation https://opensource.deepmedia.io/deployer/configuration, I created the following configuration:

projectInfo {
        // https://opensource.deepmedia.io/deployer/configuration
        val projectName = rootProject.name
        url.set("https://github.com/Hansanto/$projectName")
        scm {
            fromGithub("Hansanto", projectName)
        }
    }

But when I checked the published version: https://central.sonatype.com/artifact/io.github.hansanto/kault/1.6.1, the description is "kault" (the name of the project)

So, I tried to change to set the description based of the rootProject data:

projectInfo {
        // https://opensource.deepmedia.io/deployer/configuration
        val projectName = rootProject.name
        description.set(rootProject.description)
        url.set("https://github.com/Hansanto/$projectName")
        scm {
            fromGithub("Hansanto", projectName)
        }
    }

And the problem is fixed.

What's the problem

On the documentation, there is information about default description:

// Project description. Defaults to rootProject.name
   description.set("Handy tool to publish maven packages in different repositories.")

so, maybe there is a bug, or maybe the documentation Is outdated

Links

Project configuration where the bug is: https://github.com/Hansanto/kault/blob/417a00044e4988bb40ad3411581aee73ed0eb101/build.gradle.kts#L250

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions