Publishing a Release

Publishing a Release

Follow these steps when preparing and publishing a new Hytale mod release.

1. Update your project version

Set the release version in your Gradle build, for example:

version = "1.0.0"

HytalePublisher uses project.version by default unless you override hytalePublisher.version.

2. Update your changelog

Create or update the changelog file configured by changelogFile.

By default, HytalePublisher uses:

changelog.md

If the configured changelog file does not exist, HytalePublisher creates it automatically with a basic Markdown heading.

Changelog file names are matched case-insensitively. For example, all of these are treated as valid matches for the default changelog.md:

changelog.md
CHANGELOG.md
CHANGELOg.md

The path is resolved relative to the root project directory unless an absolute path is provided.

3. Configure the platforms you want to publish to

Enable only the platforms you want to publish this release to:

hytalePublisher {
    modtale {
        enabled = true
        projectId = "your-modtale-project-id"
    }

    curseforge {
        enabled = true
        projectId = "123456"
    }

    modifold {
        enabled = false
        projectId = "your-modifold-project-slug"
    }
}

Only enabled platforms will register publish tasks.

4. Add credentials

For local publishing, add API keys to key.properties:

modTaleKey=your-modtale-api-key
curseKey=your-curseforge-api-token
modifoldKey=your-modifold-bearer-token

For CI/CD publishing, provide the matching environment variables instead.

5. Build and publish

Publish to a single platform:

./gradlew publishToModtale
./gradlew publishToCurseForge
./gradlew publishToModifold

Publish to every enabled platform:

./gradlew publishAll

Use --info or --stacktrace if you need detailed error output during publishing.

All publishing tasks automatically depend on build, so your mod artifact is built before upload.