Adjust and document publishing

Author: tomwyr

.github/workflows/build.yaml

@@ -21,6 +21,9 @@ jobs:
         java-version: '21'
         distribution: 'temurin'
 
+    - name: Create properties from environment
+      run: sh scripts/create-properties.sh
+
     # Configure Gradle for optimal use in GiHub Actions, including caching of downloaded dependencies.
     # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
     - name: Setup Gradle
@@ -54,6 +57,9 @@ jobs:
         java-version: '21'
         distribution: 'temurin'
 
+    - name: Create properties from environment
+      run: sh scripts/create-properties.sh
+
     # Generates and submits a dependency graph, enabling Dependabot Alerts for all project dependencies.
     # See: https://github.com/gradle/actions/blob/main/dependency-submission/README.md
     - name: Generate and submit dependency graph

INTERNAL.md

@@ -4,7 +4,7 @@ The following documentation provides additional knowledge about the project that
 
 # Local properties
 
-The following properties should be set locally in the `local.properties` file in order to support build and development capabilities.
+The following properties should be set locally in the `local.properties` file in order to support build and publishing tasks.
 
 | Property               | Usage |
 | ---------------------- | ----- |
@@ -14,3 +14,29 @@ The following properties should be set locally in the `local.properties` file in
 | maven.repo.password    | Maven repository password. Required when publishing to Maven repository using the `maven-publish` plugin. |
 | maven.signing.key      | ASCII armored secret key. Required to sign the artifact using the `maven-publish` plugin. |
 | maven.signing.password | Passphrase of the secret key. Required to sign the artifact using the `maven-publish` plugin. |
+
+# Publishing
+
+To publish a new version of the plugin to the plugin repositories, bump the `version` property in `build.gradle.kts` and run:
+- `publishPlugins` to upload the plugin to Gradle Plugin Repository,
+- `publishPluginPublicationToMavenRepository` to upload the plugin to Maven Central Repository.
+
+# Pre-release tests
+
+Testing changes before publishing built artifacts to the repositories can be done by uploading a snapshot version of the plugin.
+To do so, add `-SNAPSHOT` suffix to the next release version and upload it to Maven repository with the `publishPluginPublicationToMavenRepository` Gradle task.
+
+In the test project, configure the plugin using the legacy `apply` method as shown below:
+```
+buildscript {
+    repositories {
+        maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
+    }
+
+    dependencies {
+        classpath("io.github.tomwyr:godot-kotlin-tree:X.Y.Z-SNAPSHOT")
+    }
+}
+
+apply<GodotNodeTree>()
+```

build.gradle.kts

@@ -1,5 +1,9 @@
 import com.adarshr.gradle.testlogger.TestLoggerExtension
 import com.adarshr.gradle.testlogger.theme.ThemeType
+import java.io.FileInputStream
+import java.util.*
+
+val localProperties = loadLocalProps()
 
 version = "1.0.1"
 group = "io.github.tomwyr"
@@ -32,8 +36,9 @@ gradlePlugin {
     website = "https://github.com/tomwyr/godot-kotlin-tree"
     vcsUrl = "https://github.com/tomwyr/godot-kotlin-tree.git"
 
-    envToProp("GRADLE_PUBLISH_KEY", "gradle.publish.key")
-    envToProp("GRADLE_PUBLISH_SECRET", "gradle.publish.secret")
+    fun bindProp(key: String) = System.setProperty(key, prop(key))
+    bindProp("gradle.publish.key")
+    bindProp("gradle.publish.secret")
 
     plugins {
         create("godot-kotlin-tree") {
@@ -92,25 +97,28 @@ publishing {
             url = uri(if (isSnapshot) snapshotsRepoUrl else releasesRepoUrl)
 
             credentials {
-                username = env("MAVEN_REPO_USERNAME")
-                password = env("MAVEN_REPO_PASSWORD")
+                username = prop("maven.repo.username")
+                password = prop("maven.repo.password")
             }
         }
     }
 }
 
 signing {
-    val signingKey = env("MAVEN_SIGNING_KEY")
-    val signingPassword = env("MAVEN_SIGNING_PASSWORD")
+    isRequired = true
+    val signingKey = prop("maven.signing.key").replace("\\n", "\n")
+    val signingPassword = prop("maven.signing.password")
     useInMemoryPgpKeys(signingKey, signingPassword)
     sign(publishing.publications["plugin"])
 }
 
 val isSnapshot: Boolean
     get() = version.toString().endsWith("SNAPSHOT")
 
-fun env(key: String): String? = System.getenv(key)
+fun loadLocalProps() = Properties().apply {
+    load(FileInputStream(rootProject.file("local.properties")))
+}
 
-fun envToProp(envKey: String, propKey: String, defaultValue: String = "") {
-    System.setProperty(propKey, System.getenv(envKey) ?: defaultValue)
+fun prop(key: String): String {
+    return localProperties[key] as? String ?: throw Exception("Expected local property $key not set")
 }

scripts/create-properties.sh

@@ -0,0 +1,8 @@
+cat > local.properties << EOFecho
+        gradle.publish.key=
+        gradle.publish.secret=
+        maven.repo.username=
+        maven.repo.password=
+        maven.signing.key=
+        maven.signing.password=
+        EOF