feat: GitHub Action for artifact deployment

.cz.toml

@@ -0,0 +1,6 @@
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "v$version"
+version_scheme = "semver"
+version = "0.1.0-SNAPSHOT"
+major_version_zero = true

.github/workflows/flow-deploy-release-artifact.yaml

@@ -0,0 +1,75 @@
+##
+# Copyright (C) 2023 Hedera Hashgraph, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+name: "Deploy Release Artifact"
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+-?*"
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  prepare-tag-release:
+    name: Release / Tag / Prepare
+    runs-on: [self-hosted, Linux, medium, ephemeral]
+    outputs:
+      version: ${{ steps.tag.outputs.version }}
+      prerelease: ${{ steps.tag.outputs.prerelease }}
+    steps:
+      - name: Install Semantic Version Tools
+        run: |
+          echo "::group::Download SemVer Binary"
+          sudo curl -L -o /usr/local/bin/semver https://raw.githubusercontent.com/fsaintjacques/semver-tool/master/src/semver
+          echo "::endgroup::"
+          echo "::group::Change SemVer Binary Permissions"
+          sudo chmod -v +x /usr/local/bin/semver
+          echo "::endgroup::"
+          echo "::group::Show SemVer Binary Version Info"
+          semver --version
+          echo "::endgroup::"
+
+      - name: Extract Tag Version
+        id: tag
+        run: |
+          RELEASE_VERSION="$(semver get release "${{ github.ref_name }}")"
+          PRERELEASE_VERSION="$(semver get prerel "${{ github.ref_name }}")"
+
+          FINAL_VERSION="${RELEASE_VERSION}"
+          PRERELEASE_FLAG="false"
+          [[ -n "${PRERELEASE_VERSION}" ]] && FINAL_VERSION="${RELEASE_VERSION}-${PRERELEASE_VERSION}"
+          [[ -n "${PRERELEASE_VERSION}" ]] && PRERELEASE_FLAG="true"
+
+          echo "version=${FINAL_VERSION}" >>"${GITHUB_OUTPUT}"
+          echo "prerelease=${PRERELEASE_FLAG}" >>"${GITHUB_OUTPUT}"
+
+  release-tag:
+    name: Release / Tag
+    uses: ./.github/workflows/zxc-release-maven-central.yaml
+    needs:
+      - prepare-tag-release
+    with:
+      new-version: ${{ needs.prepare-tag-release.outputs.version }}
+    secrets:
+#      access-token: ${{ secrets.GITHUB_TOKEN }}
+      gpg-key-contents: ${{ secrets.GPG_KEY_CONTENTS }}
+      gpg-key-passphrase: ${{ secrets.GPG_KEY_PASSPHRASE }}
+      git-user-name: ${{ secrets.GIT_USER_NAME }}
+      git-user-email: ${{ secrets.GIT_USER_EMAIL }}
+      ossrh-user-name: ${{ secrets.OSSRH_USER_NAME }}
+      ossrh-user-password: ${{ secrets.OSSRH_USER_PASSWORD }}

.github/workflows/zxc-release-maven-central.yaml

@@ -0,0 +1,178 @@
+##
+# Copyright (C) 2022-2023 Hedera Hashgraph, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+name: "ZXC: Release Maven Central"
+on:
+  workflow_call:
+    inputs:
+      new-version:
+        description: "New Release Version (ie. 0.30.0):"
+        type: string
+        required: true
+      dry-run-enabled:
+        description: "Perform Dry Run"
+        type: boolean
+        required: false
+        default: false
+      java-distribution:
+        description: "Java JDK Distribution:"
+        type: string
+        required: false
+        default: "temurin"
+      java-version:
+        description: "Java JDK Version:"
+        type: string
+        required: false
+        default: "17.0.3"
+      gradle-version:
+        description: "Gradle Version:"
+        type: string
+        required: false
+        default: "wrapper"
+      custom-job-label:
+        description: "Custom Job Label:"
+        type: string
+        required: false
+        default: "Release"
+    outputs:
+      release-notes:
+        description: "Release notes for the new release"
+        value: ${{ jobs.release.outputs.notes }}
+    secrets:
+      gpg-key-contents:
+        required: false
+      gpg-key-passphrase:
+        required: false
+      git-user-name:
+        required: false
+      git-user-email:
+        required: false
+      ossrh-user-name:
+        required: true
+      ossrh-user-password:
+        required: true
+
+defaults:
+  run:
+    shell: bash
+
+permissions:
+  id-token: write
+  contents: write
+
+jobs:
+  release:
+    name: ${{ inputs.custom-job-label || 'Release' }}
+    runs-on: [self-hosted, Linux, medium, ephemeral]
+    outputs:
+      notes: ${{ steps.create-release-notes.outputs.RELEASE_NOTES }}
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install GnuPG Tools
+        run: |
+          if ! command -v gpg2 >/dev/null 2>&1; then
+            echo "::group::Updating APT Repository Indices"
+              sudo apt update
+            echo "::endgroup::"
+            echo "::group::Installing GnuPG Tools"
+              sudo apt install -y gnupg2
+            echo "::endgroup::"
+          fi
+
+      - name: Install Commitizen Tools
+        run: sudo pip3 install -U commitizen
+
+      - name: Import GPG key
+        id: gpg_key
+        uses: crazy-max/ghaction-import-gpg@v5
+        if: ${{ inputs.dry-run-enabled != true && !cancelled() && !failure() }}
+        with:
+          gpg_private_key: ${{ secrets.gpg-key-contents }}
+          passphrase: ${{ secrets.gpg-key-passphrase }}
+          git_config_global: true
+          git_user_signingkey: true
+          git_commit_gpgsign: true
+          git_tag_gpgsign: true
+
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: ${{ inputs.java-distribution }}
+          java-version: ${{ inputs.java-version }}
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+        with:
+          gradle-version: ${{ inputs.gradle-version }}
+          gradle-home-cache-includes: |
+            caches
+            notifications
+            dependency-check-data
+
+      - name: Apply Version Number Update (Explicit)
+        uses: gradle/gradle-build-action@v2
+        with:
+          gradle-version: ${{ inputs.gradle-version }}
+          arguments: "versionAsSpecified --scan -PnewVersion=${{ inputs.new-version }}"
+
+      - name: Create Release Notes
+        id: create-release-notes
+        run: |
+          echo "RELEASE_NOTES<<EOF" >> "$GITHUB_OUTPUT"
+          cz changelog --dry-run "$(cz version --project)" >> "$GITHUB_OUTPUT"
+          echo "EOF" >> "$GITHUB_OUTPUT"
+
+      - name: Display Release Notes
+        run: |
+            echo "Release Notes:"
+            echo "${{ steps.create-release-notes.outputs.RELEASE_NOTES }}"
+
+      - name: Version Report
+        uses: gradle/gradle-build-action@v2
+        with:
+          gradle-version: ${{ inputs.gradle-version }}
+          arguments: githubVersionSummary --scan
+
+      - name: Gradle Assemble
+        id: gradle-build
+        uses: gradle/gradle-build-action@v2
+        if: ${{ inputs.dry-run-enabled != true && !cancelled() && !failure() }}
+        with:
+          gradle-version: ${{ inputs.gradle-version }}
+          arguments: assemble --scan
+
+      - name: Gradle JavaDoc
+        id: gradle-javadoc
+        uses: gradle/gradle-build-action@v2
+        if: ${{ steps.gradle-build.conclusion == 'success' && !cancelled() && !failure() }}
+        with:
+          gradle-version: ${{ inputs.gradle-version }}
+          arguments: javadoc --scan
+
+      - name: Gradle Deploy
+        uses: gradle/gradle-build-action@v2
+        if: ${{ inputs.dry-run-enabled != true && !cancelled() && !failure() }}
+        env:
+          OSSRH_USERNAME: ${{ secrets.ossrh-user-name }}
+          OSSRH_PASSWORD: ${{ secrets.ossrh-user-password }}
+        with:
+          gradle-version: ${{ inputs.gradle-version }}
+          # always run with --no-parallel to avoid sonatype maven publish issues which result in invalid publications
+          arguments: releaseMavenCentral --scan -PpublishSigningEnabled=true --no-parallel

buildSrc/src/main/kotlin/Utils.kt

@@ -0,0 +1,89 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import net.swiftzer.semver.SemVer
+import org.gradle.api.Project
+import java.io.File
+import java.io.OutputStream
+import java.io.PrintStream
+
+class Utils {
+    companion object {
+        @JvmStatic
+        fun updateVersion(project: Project, newVersion: SemVer) {
+            val gradlePropFile = File(project.projectDir, "gradle.properties")
+            updateStringInFile(gradlePropFile, "version=", "version=${newVersion}")
+        }
+
+        @JvmStatic
+        fun updateCommitizenVersion(project: Project, newVersion: SemVer) {
+            val czFile = File(project.projectDir, ".cz.toml")
+            updateStringInFile(czFile, "version =", "version = \"${newVersion}\"")
+        }
+
+        private fun updateStringInFile(file: File, startsWith: String, newString: String) {
+            var lines: List<String> = mutableListOf()
+
+            if (file.exists()) {
+                lines = file.readLines(Charsets.UTF_8)
+            }
+
+            val finalLines: List<String>
+
+            if (lines.isNotEmpty()) {
+                finalLines = lines.map {
+                    if (it.trimStart().startsWith(startsWith)) {
+                        newString
+                    } else {
+                        it
+                    }
+                }
+            } else {
+                finalLines = listOf(newString)
+            }
+
+            file.bufferedWriter(Charsets.UTF_8).use {
+                val writer = it
+                finalLines.forEach {
+                    writer.write(it)
+                    writer.newLine()
+                }
+                writer.flush()
+            }
+        }
+
+        @JvmStatic
+        fun generateProjectVersionReport(rootProject: Project, ostream: OutputStream) {
+            val writer = PrintStream(ostream, false, Charsets.UTF_8)
+
+            ostream.use {
+                writer.use {
+                    // Writer headers
+                    writer.println("### Deployed Version Information")
+                    writer.println()
+                    writer.println("| Artifact Name | Version Number |")
+                    writer.println("| --- | --- |")
+
+                    // Write table rows
+                    rootProject.childProjects.values.onEach {
+                        writer.printf("| %s | %s |\n", it.name, it.version.toString())
+                    }
+                    writer.flush()
+                    ostream.flush()
+                }
+            }
+        }
+    }
+}