xyz.unifycraft.gradle.tools.releases

About

Configures multiple Gradle plugins to aide you in managing your project's releases and automate releasing to Modrinth, Curseforge and GitHub.

Usage

General

releases {
    // Set the `version` appropriately. This is your current mod version. This will be automatically set to your project version.
    // Set the `versionType` appropriately. This can either be `RELEASE`, `BETA` or `ALPHA`. This defaults to `RELEASE`.
    // Set the `gameVersions` appropriately.  This defaults to `MCData#versionStr`.
    // Set the `loaders` appropriately. This defaults to `MCData#loader`
    // Set the `file` appropriately. This defaults to the `jar` task's output.
    // Set the `changelog` appropriately. This defaults to "No changelog provided.".
}

Modrinth

releases {
    modrinth {
        projectId.set("your project ID")
        // You can set `dependencies` here.
    }
}

CurseForge

releases {
    curseforge {
        // Set the `releaseName` appropriately.
        projectId.set("your project ID")
        // You can set `dependencies` here.
        // You can set a `changelogType` here if a `changelog` is present.
    }
}

GitHub

releases {
    github {
        // Set the `owner` here. This defaults to the item after the last . in the group.
        // Set the `repository` here. This is the repository name and defaults to the root project name.
        // Set `targetCommitish` here. This is the branch the release is from. This defaults to "main".
        // Set the `releaseName` here. This will be the GitHub release title.
        // Set the `draft` here. It determines whether this release is a draft and will be shown publically. This means it will be private until published. This defaults to `false`.
    }
}