Release ZomboidDoc v3.1.0

Author: matshou

.github/workflows/java-cd.yaml

@@ -200,7 +200,7 @@ jobs:
           release_name: ${{ steps.read-tag.outputs.name }}
           prerelease: ${{ steps.read-tag.outputs.isPreRelease }}
           body_path: ./release_text.md
-          draft: false
+          draft: true
       # Upload distribution artifact to release
       - name: Upload distribution zip
         uses: actions/upload-release-asset@v1
@@ -221,11 +221,8 @@ jobs:
           asset_path: ./build/distributions/pz-zdoc-${{ steps.read-tag.outputs.name }}.tar
           asset_name: pz-zdoc-${{ steps.read-tag.outputs.name }}.tar
           asset_content_type: application/tar
-      # Publish publication to Github packages with Maven
+      # Publish to Sonatype repository
       - uses: burrunan/gradle-cache-action@v1
-        name: Publish to Github packages
-        env:
-          GHP_USER: yooksi
-          GHP_TOKEN: ${{ secrets.PUBLISH_TOKEN }}
+        name: Publish to Sonatype
         with:
-          arguments: publishZdocPublicationToGitHubPackagesRepository
+          arguments: publishToSonatypeAndCloseStagingRepository

.gitignore

@@ -4,6 +4,9 @@ local.properties
 # Generated Lua
 /media/
 
+# Temporary files
+serialize.lua
+
 ### IntelliJ ###
 
 # Project file-based format

.idea/GrepConsole.xml

@@ -44,7 +44,7 @@ It is also possible to setup ZomboidDoc with Gradle without using ZomboidMod:
 ```groovy
 // Github Packages repository credentials
 project.ext.cocoLabsRepo = 'pz-zdoc'
-apply from: 'https://git.io/JtydE'
+apply from: 'https://git.io/JmWv6'
 
 dependencies {
     // https://github.com/orgs/cocolabs/packages?repo_name=pz-zdoc

.idea/runConfigurations/help.xml .idea/runConfigurations/annotateLua.xml

@@ -8,6 +8,12 @@ plugins {
     // https://docs.gradle.org/current/userguide/maven_plugin.html
     id 'maven-publish'
 
+    // https://docs.gradle.org/current/userguide/signing_plugin.html
+    id 'signing'
+
+    // https://docs.gradle.org/current/userguide/signing_plugin.html
+    id "io.github.gradle-nexus.publish-plugin" version "1.0.0"
+
     // https://docs.gradle.org/current/userguide/jacoco_plugin.html
     id 'jacoco'
 
@@ -21,10 +27,13 @@ plugins {
     id 'com.github.jk1.dependency-license-report' version '1.16'
 }
 apply from: 'setup.gradle'
+if (!CI) {
+    apply from: 'zomboid.gradle'
+}
 apply from: 'spotless.gradle'
-apply from: 'distribution.gradle'
+apply from: 'publish.gradle'
 
-group 'io.cocolabs'
+group 'io.github.cocolabs'
 version file('version.txt').readLines().get(0)
 
 wrapper {
@@ -168,7 +177,7 @@ dependencies {
         zomboidRuntimeOnly fileTree(dir: gameDir, include: ['*.jar'])
 
         // Project Zomboid classes
-        zomboidImplementation files(zomboidClassesDir)
+        zomboidImplementation files('lib/zomboid.jar')
     }
 }
 

.idea/runConfigurations/version.xml .idea/runConfigurations/compileLua.xml

@@ -51,12 +51,13 @@ public class ZUnixStartScriptGenerator implements ScriptGenerator {
 
 	public ZUnixStartScriptGenerator() {
 		this.lineSeparator = TextUtil.getUnixLineSeparator();
-		this.scriptTemplate = readScriptResourceFile("unixScriptTemplate.sh");
+		this.scriptTemplate = readScriptResourceFile();
 		this.bindingFactory = StartScriptTemplateBindingFactory.unix();
 	}
 
-	private static String readScriptResourceFile(String filename) {
+	private static String readScriptResourceFile() {
 
+		String filename = "unixScriptTemplate.sh";
 		try (InputStream iStream = CL.getResourceAsStream(filename))
 		{
 			if (iStream == null) {

.idea/runConfigurations/luaDocJar.xml

@@ -51,12 +51,13 @@ public class ZWindowsStartScriptGenerator implements ScriptGenerator {
 
 	public ZWindowsStartScriptGenerator() {
 		this.lineSeparator = TextUtil.getWindowsLineSeparator();
-		this.scriptTemplate = readScriptResourceFile("winScriptTemplate.bat");
+		this.scriptTemplate = readScriptResourceFile();
 		this.bindingFactory = StartScriptTemplateBindingFactory.windows();
 	}
 
-	private static String readScriptResourceFile(String filename) {
+	private static String readScriptResourceFile() {
 
+		String filename = "winScriptTemplate.bat";
 		try (InputStream iStream = CL.getResourceAsStream(filename))
 		{
 			if (iStream == null) {

.idea/scopes/pz_java.xml

@@ -1,7 +1,3 @@
-// set repository owner and name
-project.ext.set('repo.owner', 'cocolabs')
-project.ext.set('repo.name', 'pz-zdoc')
-
 // changelog.gradle
 apply from: 'https://git.io/JqJiC'
 

README.md

@@ -1,2 +1,3 @@
-orepo.owner=cocolabs
+# suppress inspection "UnusedProperty" for whole file
+repo.owner=cocolabs
 repo.name=pz-zdoc

build.gradle

@@ -0,0 +1,122 @@
+// changelog.gradle
+apply from: 'https://git.io/JqJiC'
+
+distributions.main.contents {
+    it.from ('README.md', 'LICENSE.txt', 'CHANGELOG.md')
+    // version.txt is used by version command
+    it.from(projectDir) {
+        it.include 'version.txt'
+    }
+    it.exclude {
+        File file = it.file
+        String filename = file.getName()
+        /*
+         * there is a bug that occurs when running distribution tasks on Github CI
+         * where the distribution archive tries to add itself to archive
+         * @see https://github.com/cocolabs/pz-zdoc/issues/21
+         */
+        if (filename.startsWith(archivesBaseName) && filename.endsWithAny('.zip', '.tar')) {
+            return true
+        }
+        if (!CI) {
+            // exclude Project Zomboid classes
+            if (file.toPath().startsWith(zomboidClassesDir.toPath())) {
+                return true
+            }
+            // exclude Project Zomboid libraries
+            if (file.toPath().startsWith(gameDir)) {
+                return true
+            }
+        }
+        return false
+    }
+}
+// generate changelog BEFORE creating distribution
+[ 'assemble', 'assembleDist', 'installDist' ].forEach({
+    tasks.named(it).configure({it.dependsOn('generateChangelog')})
+})
+// run distribution archive tasks AFTER generating changelog
+[ 'distTar', 'distZip' ].forEach({
+    tasks.named(it).configure({it.mustRunAfter('generateChangelog')})
+})
+def cleanScripts = tasks.register('cleanScripts', Delete.class) {
+    it.description('Delete build scripts directory.')
+    it.group('zomboid')
+    it.delete("$buildDir/scripts")
+}
+tasks.named('installDist').configure{
+    it.dependsOn(cleanScripts)
+}
+
+tasks.named('startScripts').configure {
+    it.setWindowsStartScriptGenerator(new ZWindowsStartScriptGenerator())
+    it.setUnixStartScriptGenerator(new ZUnixStartScriptGenerator())
+
+    // do not add provided files to classpath, they are not included in distribution
+    it.classpath -= configurations.zomboidImplementation
+}
+
+// include version information in jar
+jar.from 'version.txt'
+
+task javadocJar(type: Jar) {
+    archiveClassifier.set('javadoc')
+    from javadoc
+}
+
+task sourcesJar(type: Jar) {
+    archiveClassifier.set('sources')
+    from sourceSets.main.allSource
+}
+
+artifacts {
+    archives javadocJar, sourcesJar
+}
+
+publishing {
+    publications {
+        //noinspection GroovyAssignabilityCheck
+        mavenJava(MavenPublication) {
+            pom {
+                name = 'ZomboidDoc'
+                description = 'ZomboidDoc is a Lua library compiler for Project Zomboid.'
+                url = 'https://github.com/cocolabs/pz-zdoc'
+                scm {
+                    connection = 'scm:git:git://github.com/cocolabs/pz-zdoc.git'
+                    developerConnection = 'scm:git:ssh://github.com:cocolabs/pz-zdoc.git'
+                    url = 'https://github.com/cocolabs/pz-zdoc'
+                }
+                licenses {
+                    license {
+                        name = 'GNU General Public License v3.0'
+                        url = 'https://www.gnu.org/licenses/gpl-3.0.en.html'
+                    }
+                }
+                developers {
+                    developer {
+                        id = 'yooks'
+                        name = 'Matthew Cain'
+                        email = '[email protected]'
+                    }
+                }
+            }
+        }
+    }
+}
+
+signing {
+    sign publishing.publications.mavenJava
+}
+
+nexusPublishing {
+    repositories {
+        sonatype {
+            nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/"))
+            snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/"))
+        }
+    }
+}
+
+task publishToSonatypeAndCloseStagingRepository {
+    dependsOn = [ 'publishToSonatype', 'closeSonatypeStagingRepository' ]
+}

buildSrc/src/main/java/ZUnixStartScriptGenerator.java

@@ -121,12 +121,9 @@ def <T> void registerLocalProjectProperty(String name, Class<T> type, String env
 if (!CI) {
     // path to Project Zomboid installation directory
     registerLocalProjectProperty('gameDir', Path.class, 'PZ_DIR_PATH', true)
+
+    // path to IntelliJ IDEA installation directory
+    registerLocalProjectProperty('ideaHome', Path.class, 'IDEA_HOME', true)
 }
 // Github repository token used to generate changelog
 registerLocalProjectProperty('cg.token', String.class, 'CHANGELOG_GITHUB_TOKEN', false)
-
-// Username used to publish to Github packages with Maven
-registerLocalProjectProperty('ghp.user', String.class, 'GHP_USER', false)
-
-// Token used to publish to Github packages with Maven
-registerLocalProjectProperty('ghp.token', String.class, 'GHP_TOKEN', false)