Some checks failed
CI / test (push) Has been cancelled
- Introduced Gradle tasks for release preparation, version bumping, and git tagging. - Added CI workflow for continuous integration on pushes and pull requests. - Implemented release workflow for automated builds and Gitea releases upon tag pushes. - Created scripts for manual release processes on Windows and Linux/macOS. - Documented the release process and Gitea Actions setup in the new RELEASE.md and setup-gitea-actions.md files.
281 lines
11 KiB
Groovy
281 lines
11 KiB
Groovy
plugins {
|
|
id 'eclipse'
|
|
id 'idea'
|
|
id 'maven-publish'
|
|
id 'net.minecraftforge.gradle' version '[6.0,6.2)'
|
|
id 'org.ajoberstar.grgit' version '5.2.0'
|
|
}
|
|
|
|
version = mod_version
|
|
group = mod_group_id
|
|
|
|
base {
|
|
archivesName = mod_id
|
|
}
|
|
|
|
// Mojang ships Java 17 to end users in 1.18+, so your mod should target Java 17.
|
|
java.toolchain.languageVersion = JavaLanguageVersion.of(17)
|
|
|
|
println "Java: ${System.getProperty 'java.version'}, JVM: ${System.getProperty 'java.vm.version'} (${System.getProperty 'java.vendor'}), Arch: ${System.getProperty 'os.arch'}"
|
|
minecraft {
|
|
// The mappings can be changed at any time and must be in the following format.
|
|
// Channel: Version:
|
|
// official MCVersion Official field/method names from Mojang mapping files
|
|
// parchment YYYY.MM.DD-MCVersion Open community-sourced parameter names and javadocs layered on top of official
|
|
//
|
|
// You must be aware of the Mojang license when using the 'official' or 'parchment' mappings.
|
|
// See more information here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md
|
|
//
|
|
// Parchment is an unofficial project maintained by ParchmentMC, separate from MinecraftForge
|
|
// Additional setup is needed to use their mappings: https://parchmentmc.org/docs/getting-started
|
|
//
|
|
// Use non-default mappings at your own risk. They may not always work.
|
|
// Simply re-run your setup task after changing the mappings to update your workspace.
|
|
mappings channel: mapping_channel, version: mapping_version
|
|
|
|
// When true, this property will have all Eclipse/IntelliJ IDEA run configurations run the "prepareX" task for the given run configuration before launching the game.
|
|
// In most cases, it is not necessary to enable.
|
|
// enableEclipsePrepareRuns = true
|
|
// enableIdeaPrepareRuns = true
|
|
|
|
// This property allows configuring Gradle's ProcessResources task(s) to run on IDE output locations before launching the game.
|
|
// It is REQUIRED to be set to true for this template to function.
|
|
// See https://docs.gradle.org/current/dsl/org.gradle.language.jvm.tasks.ProcessResources.html
|
|
copyIdeResources = true
|
|
|
|
// When true, this property will add the folder name of all declared run configurations to generated IDE run configurations.
|
|
// The folder name can be set on a run configuration using the "folderName" property.
|
|
// By default, the folder name of a run configuration is the name of the Gradle project containing it.
|
|
// generateRunFolders = true
|
|
|
|
// This property enables access transformers for use in development.
|
|
// They will be applied to the Minecraft artifact.
|
|
// The access transformer file can be anywhere in the project.
|
|
// However, it must be at "META-INF/accesstransformer.cfg" in the final mod jar to be loaded by Forge.
|
|
// This default location is a best practice to automatically put the file in the right place in the final jar.
|
|
// See https://docs.minecraftforge.net/en/latest/advanced/accesstransformers/ for more information.
|
|
// accessTransformer = file('src/main/resources/META-INF/accesstransformer.cfg')
|
|
|
|
// Default run configurations.
|
|
// These can be tweaked, removed, or duplicated as needed.
|
|
runs {
|
|
// applies to all the run configs below
|
|
configureEach {
|
|
workingDirectory project.file('run')
|
|
|
|
// Recommended logging data for a userdev environment
|
|
// The markers can be added/remove as needed separated by commas.
|
|
// "SCAN": For mods scan.
|
|
// "REGISTRIES": For firing of registry events.
|
|
// "REGISTRYDUMP": For getting the contents of all registries.
|
|
property 'forge.logging.markers', 'REGISTRIES'
|
|
|
|
// Recommended logging level for the console
|
|
// You can set various levels here.
|
|
// Please read: https://stackoverflow.com/questions/2031163/when-to-use-the-different-log-levels
|
|
property 'forge.logging.console.level', 'debug'
|
|
|
|
mods {
|
|
"${mod_id}" {
|
|
source sourceSets.main
|
|
}
|
|
}
|
|
}
|
|
|
|
client {
|
|
// Comma-separated list of namespaces to load gametests from. Empty = all namespaces.
|
|
property 'forge.enabledGameTestNamespaces', mod_id
|
|
}
|
|
|
|
server {
|
|
property 'forge.enabledGameTestNamespaces', mod_id
|
|
args '--nogui'
|
|
}
|
|
|
|
// This run config launches GameTestServer and runs all registered gametests, then exits.
|
|
// By default, the server will crash when no gametests are provided.
|
|
// The gametest system is also enabled by default for other run configs under the /test command.
|
|
gameTestServer {
|
|
property 'forge.enabledGameTestNamespaces', mod_id
|
|
}
|
|
|
|
data {
|
|
// example of overriding the workingDirectory set in configureEach above
|
|
workingDirectory project.file('run-data')
|
|
|
|
// Specify the modid for data generation, where to output the resulting resource, and where to look for existing resources.
|
|
args '--mod', mod_id, '--all', '--output', file('src/generated/resources/'), '--existing', file('src/main/resources/')
|
|
}
|
|
}
|
|
}
|
|
|
|
// Include resources generated by data generators.
|
|
sourceSets.main.resources { srcDir 'src/generated/resources' }
|
|
|
|
repositories {
|
|
// Put repositories for dependencies here
|
|
// ForgeGradle automatically adds the Forge maven and Maven Central for you
|
|
maven { url = 'https://repo.lucko.me/' }
|
|
}
|
|
|
|
dependencies {
|
|
// Specify the version of Minecraft to use.
|
|
// Any artifact can be supplied so long as it has a "userdev" classifier artifact and is a compatible patcher artifact.
|
|
// The "userdev" classifier will be requested and setup by ForgeGradle.
|
|
// If the group id is "net.minecraft" and the artifact id is one of ["client", "server", "joined"],
|
|
// then special handling is done to allow a setup of a vanilla dependency without the use of an external repository.
|
|
minecraft "net.minecraftforge:forge:${minecraft_version}-${forge_version}"
|
|
|
|
// LuckPerms API (soft dependency)
|
|
compileOnly 'net.luckperms:api:5.4'
|
|
|
|
// Example mod dependency using a mod jar from ./libs with a flat dir repository
|
|
// This maps to ./libs/coolmod-${mc_version}-${coolmod_version}.jar
|
|
// The group id is ignored when searching -- in this case, it is "blank"
|
|
// implementation fg.deobf("blank:coolmod-${mc_version}:${coolmod_version}")
|
|
|
|
// For more info:
|
|
// http://www.gradle.org/docs/current/userguide/artifact_dependencies_tutorial.html
|
|
// http://www.gradle.org/docs/current/userguide/dependency_management.html
|
|
}
|
|
|
|
// This block of code expands all declared replace properties in the specified resource targets.
|
|
// A missing property will result in an error. Properties are expanded using ${} Groovy notation.
|
|
// When "copyIdeResources" is enabled, this will also run before the game launches in IDE environments.
|
|
// See https://docs.gradle.org/current/dsl/org.gradle.language.jvm.tasks.ProcessResources.html
|
|
tasks.named('processResources', ProcessResources).configure {
|
|
var replaceProperties = [
|
|
minecraft_version: minecraft_version, minecraft_version_range: minecraft_version_range,
|
|
forge_version: forge_version, forge_version_range: forge_version_range,
|
|
loader_version_range: loader_version_range,
|
|
mod_id: mod_id, mod_name: mod_name, mod_license: mod_license, mod_version: mod_version,
|
|
mod_authors: mod_authors, mod_description: mod_description,
|
|
]
|
|
inputs.properties replaceProperties
|
|
|
|
filesMatching(['META-INF/mods.toml', 'pack.mcmeta']) {
|
|
expand replaceProperties + [project: project]
|
|
}
|
|
}
|
|
|
|
// Example for how to get properties into the manifest for reading at runtime.
|
|
tasks.named('jar', Jar).configure {
|
|
manifest {
|
|
attributes([
|
|
'Specification-Title' : mod_id,
|
|
'Specification-Vendor' : mod_authors,
|
|
'Specification-Version' : '1', // We are version 1 of ourselves
|
|
'Implementation-Title' : project.name,
|
|
'Implementation-Version' : project.jar.archiveVersion,
|
|
'Implementation-Vendor' : mod_authors,
|
|
'Implementation-Timestamp': new Date().format("yyyy-MM-dd'T'HH:mm:ssZ")
|
|
])
|
|
}
|
|
|
|
// This is the preferred method to reobfuscate your jar file
|
|
finalizedBy 'reobfJar'
|
|
}
|
|
|
|
// However if you are in a multi-project build, dev time needs unobfed jar files, so you can delay the obfuscation until publishing by doing:
|
|
// tasks.named('publish').configure {
|
|
// dependsOn 'reobfJar'
|
|
// }
|
|
|
|
// Example configuration to allow publishing using the maven-publish plugin
|
|
publishing {
|
|
publications {
|
|
register('mavenJava', MavenPublication) {
|
|
artifact jar
|
|
}
|
|
}
|
|
repositories {
|
|
maven {
|
|
url "file://${project.projectDir}/mcmodsrepo"
|
|
}
|
|
}
|
|
}
|
|
|
|
tasks.withType(JavaCompile).configureEach {
|
|
options.encoding = 'UTF-8' // Use the UTF-8 charset for Java compilation
|
|
}
|
|
|
|
// Release automation tasks
|
|
task prepareRelease {
|
|
dependsOn 'build'
|
|
group = 'release'
|
|
description = 'Prepares release files and creates git tag'
|
|
|
|
doLast {
|
|
def tagName = "v${mod_version}"
|
|
def jarFile = file("${buildDir}/libs/${mod_id}-${mod_version}.jar")
|
|
|
|
if (!jarFile.exists()) {
|
|
throw new GradleException("JAR file not found: ${jarFile}")
|
|
}
|
|
|
|
println "Release prepared:"
|
|
println " Tag: ${tagName}"
|
|
println " JAR: ${jarFile}"
|
|
println ""
|
|
println "Next steps:"
|
|
println "1. Push the tag: git push origin ${tagName}"
|
|
println "2. Create release on Gitea manually or use Gitea Actions"
|
|
}
|
|
}
|
|
|
|
// Task to create a git tag
|
|
task createTag {
|
|
doLast {
|
|
def tagName = "v${mod_version}"
|
|
try {
|
|
grgit.tag.add(name: tagName, message: "Release ${tagName}")
|
|
println "Created tag: ${tagName}"
|
|
} catch (Exception e) {
|
|
println "Tag ${tagName} might already exist: ${e.message}"
|
|
}
|
|
}
|
|
}
|
|
|
|
// Task to push tags
|
|
task pushTags {
|
|
doLast {
|
|
try {
|
|
grgit.push(tags: true)
|
|
println "Pushed tags to remote"
|
|
} catch (Exception e) {
|
|
println "Error pushing tags: ${e.message}"
|
|
}
|
|
}
|
|
}
|
|
|
|
// Combined release task
|
|
task release {
|
|
dependsOn 'createTag', 'pushTags', 'prepareRelease'
|
|
group = 'release'
|
|
description = 'Creates a git tag, pushes it, and prepares for Gitea release'
|
|
}
|
|
|
|
// Task to bump version
|
|
task bumpVersion {
|
|
doLast {
|
|
def currentVersion = mod_version
|
|
def versionParts = currentVersion.split('\\.')
|
|
def major = versionParts[0] as Integer
|
|
def minor = versionParts[1] as Integer
|
|
def patch = versionParts[2] as Integer
|
|
|
|
// Increment patch version
|
|
patch++
|
|
def newVersion = "${major}.${minor}.${patch}"
|
|
|
|
// Update gradle.properties
|
|
def propsFile = file('gradle.properties')
|
|
def propsContent = propsFile.text
|
|
propsContent = propsContent.replaceAll("mod_version=${mod_version}", "mod_version=${newVersion}")
|
|
propsFile.text = propsContent
|
|
|
|
println "Version bumped from ${currentVersion} to ${newVersion}"
|
|
println "Don't forget to commit and push the version change!"
|
|
}
|
|
}
|