Publishing & Release

CoCache publishes to three Maven repositories: Maven Central (via Sonatype), GitHub Packages, and LinYi Packages. Publishing is automated through the package-deploy.yml GitHub Actions workflow, triggered when a GitHub Release is created.

Publishing Targets

mermaid

graph LR
    subgraph Targets["Publishing Targets"]
        direction TB
        REL["GitHub Release<br>(created)"] --> DEPLOY["package-deploy.yml"]
        DEPLOY --> GH["GitHub Packages"]
        DEPLOY --> SON["Maven Central<br>(Sonatype OSSRH)"]
        LINYI["LinYi Packages<br>(via gradle.properties)"] -.->|Manual / CI| RELEASED["Released Artifacts"]
        GH --> RELEASED
        SON --> RELEASED
    end
    style Targets fill:#161b22,stroke:#6d5dfc,color:#e6edf3
    style REL fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style DEPLOY fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style GH fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SON fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style LINYI fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style RELEASED fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

Repository	URL	Authentication	Source
GitHub Packages	`https://maven.pkg.github.com/Ahoo-Wang/CoCache`	`GITHUB_ACTOR` + `GITHUB_TOKEN`	`build.gradle.kts:138-144`
Maven Central	`https://ossrh-staging-api.central.sonatype.com/service/local/`	`SONATYPE_USERNAME` + `SONATYPE_PASSWORD`	`build.gradle.kts:208-215`
LinYi Packages	From `linyiPackageReleaseUrl` property	`linyiPackageUsername` + `linyiPackagePwd`	`build.gradle.kts:145-152`

Published Modules

All modules except cocache-example and code-coverage-report are published. The root build script defines this partition:

kotlin

// [build.gradle.kts:44](https://github.com/Ahoo-Wang/CoCache/blob/main/build.gradle.kts#L44)
val publishProjects = subprojects - serverProjects - codeCoverageReportProject

mermaid

graph TD
    subgraph PublishedModules["Published vs. Non-Published"]
        direction TB
        SUB["All Subprojects"] --> PUB["publishProjects"]
        SUB --> NON_PUB["Non-Published"]
        PUB --> BOM["cocache-bom<br>(Java Platform)"]
        PUB --> DEPS["cocache-dependencies<br>(Java Platform)"]
        PUB --> LIB["Library Modules"]
        LIB --> API["cocache-api"]
        LIB --> CORE["cocache-core"]
        LIB --> SPRING["cocache-spring"]
        LIB --> SPRING_CACHE["cocache-spring-cache"]
        LIB --> SPRING_REDIS["cocache-spring-redis"]
        LIB --> SPRING_BOOT["cocache-spring-boot-starter"]
        LIB --> TEST["cocache-test"]
        NON_PUB --> EXAMPLE["cocache-example"]
        NON_PUB --> COVERAGE["code-coverage-report"]
    end
    style PublishedModules fill:#161b22,stroke:#6d5dfc,color:#e6edf3
    style SUB fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style PUB fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style NON_PUB fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style BOM fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style DEPS fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style LIB fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style API fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style CORE fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SPRING fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SPRING_CACHE fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SPRING_REDIS fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SPRING_BOOT fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style TEST fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style EXAMPLE fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style COVERAGE fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

Published modules include javadocJar and sourcesJar artifacts, required by Maven Central:

kotlin

// [build.gradle.kts:83-86](https://github.com/Ahoo-Wang/CoCache/blob/main/build.gradle.kts#L83-L86)
configure<JavaPluginExtension> {
    withJavadocJar()
    withSourcesJar()
}

Maven Publication Structure

Each published module creates one of two publication types depending on its nature:

Module Type	Publication Name	Component	Source
BOM (Platform)	`mavenBom`	`javaPlatform`	`build.gradle.kts:155-156`
Library	`mavenLibrary`	`java`	`build.gradle.kts:155-156`

All publications include standardized POM metadata:

kotlin

// [build.gradle.kts:157-189](https://github.com/Ahoo-Wang/CoCache/blob/main/build.gradle.kts#L157-L189)
pom {
    name.set(rootProject.name)
    description.set(getPropertyOf("description"))
    url.set(getPropertyOf("website"))
    // ... license, developer, SCM metadata from gradle.properties
}

The POM properties are sourced from gradle.properties:

Property	Value	Source
`group`	`me.ahoo.cocache`	`gradle.properties:14`
`version`	`4.0.2`	`gradle.properties:15`
`description`	`Level 2 Distributed Coherence Cache Framework`	`gradle.properties:17`
`website`	`https://github.com/Ahoo-Wang/CoCache`	`gradle.properties:18`
`license_name`	`The Apache Software License, Version 2.0`	`gradle.properties:22`

Version Management

The project version is defined centrally in gradle.properties:

properties

# [gradle.properties:15](https://github.com/Ahoo-Wang/CoCache/blob/main/gradle.properties#L15)
version=4.0.2

All published artifacts share this version. To prepare a release:

Update the version property in gradle.properties
Commit the version change
Create a GitHub Release with a matching tag (e.g., v4.0.2)

The version is automatically stamped into JAR manifests:

kotlin

// [build.gradle.kts:65-68](https://github.com/Ahoo-Wang/CoCache/blob/main/build.gradle.kts#L65-L68)
tasks.withType<Jar> {
    manifest {
        attributes["Implementation-Title"] = project.name
        attributes["Implementation-Version"] = project.version
    }
}

PGP Signing

All published artifacts are PGP-signed. The signing configuration adapts between local development and CI:

kotlin

// [build.gradle.kts:192-205](https://github.com/Ahoo-Wang/CoCache/blob/main/build.gradle.kts#L192-L205)
configure<SigningExtension> {
    val isInCI = null != System.getenv("CI")
    if (isInCI) {
        val signingKeyId = System.getenv("SIGNING_KEYID")
        val signingKey = System.getenv("SIGNING_SECRETKEY")
        val signingPassword = System.getenv("SIGNING_PASSWORD")
        useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword)
    }
    if (isBom) {
        sign(publishing.publications.get("mavenBom"))
    } else {
        sign(publishing.publications.get("mavenLibrary"))
    }
}

mermaid

graph TD
    subgraph Signing["PGP Signing Flow"]
        direction TB
        CHECK{"Is CI?"}
        CHECK -->|Yes| ENV["Read from Environment:<br>SIGNING_KEYID<br>SIGNING_SECRETKEY<br>SIGNING_PASSWORD"]
        CHECK -->|No| LOCAL["Use local GPG keyring"]
        ENV --> MEMORY["useInMemoryPgpKeys()"]
        LOCAL --> MEMORY
        MEMORY --> SIGN["Sign Publication"]
        SIGN --> BOM_SIGN{"Is BOM?"}
        BOM_SIGN -->|Yes| SIGN_MAVEN_BOM["sign(mavenBom)"]
        BOM_SIGN -->|No| SIGN_MAVEN_LIB["sign(mavenLibrary)"]
    end
    style Signing fill:#161b22,stroke:#6d5dfc,color:#e6edf3
    style CHECK fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style ENV fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style LOCAL fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style MEMORY fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SIGN fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style BOM_SIGN fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SIGN_MAVEN_BOM fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SIGN_MAVEN_LIB fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

Required CI Secrets

Secret	Purpose	Used By
`SIGNING_KEYID`	PGP key identifier	Both `github-deploy` and `central-deploy` jobs
`SIGNING_SECRETKEY`	PGP private key (ASCII-armored)	Both `github-deploy` and `central-deploy` jobs
`SIGNING_PASSWORD`	PGP key passphrase	Both `github-deploy` and `central-deploy` jobs
`SONATYPE_USERNAME`	Sonatype OSSRH username	`central-deploy` job only
`SONATYPE_PASSWORD`	Sonatype OSSRH password	`central-deploy` job only
`GITHUB_TOKEN`	GitHub Packages access	`github-deploy` job (auto-provided)

Nexus Publishing (Maven Central)

CoCache uses the io.github.gradle-nexus.publish-plugin (v2.0.0) to publish to Maven Central via Sonatype's OSSRH staging API.

kotlin

// [build.gradle.kts:208-216](https://github.com/Ahoo-Wang/CoCache/blob/main/build.gradle.kts#L208-L216)
nexusPublishing {
    repositories {
        sonatype {
            nexusUrl.set(uri("https://ossrh-staging-api.central.sonatype.com/service/local/"))
            username.set(System.getenv("SONATYPE_USERNAME"))
            password.set(System.getenv("SONATYPE_PASSWORD"))
        }
    }
}

The Maven Central publishing process involves a staging workflow:

mermaid

sequenceDiagram
autonumber
    participant GH as GitHub
    participant CI as CI Runner
    participant NX as Sonatype Nexus
    participant MC as Maven Central

    GH->>CI: Trigger package-deploy.yml<br>(release created)
    CI->>CI: Checkout code
    CI->>CI: Setup JDK 17 (Temurin)
    CI->>NX: ./gradlew publishToSonatype
    NX->>NX: Upload to staging repository
    CI->>NX: closeAndReleaseSonatypeStagingRepository
    NX->>NX: Validate (PGP signatures,<br>POM metadata, sources/javadoc JARs)
    NX->>MC: Release to Maven Central
    MC-->>GH: Artifacts available<br>(may take 10-30 min)

Maven Central Requirements

Maven Central enforces strict requirements that CoCache satisfies:

Requirement	How CoCache Meets It	Source
PGP signatures	All publications signed via `SigningExtension`	`build.gradle.kts:192-205`
Sources JAR	`withSourcesJar()` on all library modules	`build.gradle.kts:84`
Javadoc JAR	`withJavadocJar()` on all library modules (Dokka generates Kotlin docs)	`build.gradle.kts:85`
POM metadata	`name`, `description`, `url`, `licenses`, `developers`, `scm`	`build.gradle.kts:159-188`
Group ID ownership	`me.ahoo.cocache` verified via Sonatype namespace	`gradle.properties:14`

GitHub Packages

GitHub Packages provides a secondary distribution channel, tightly integrated with the GitHub repository.

kotlin

// [build.gradle.kts:138-144](https://github.com/Ahoo-Wang/CoCache/blob/main/build.gradle.kts#L138-L144)
maven {
    name = "GitHubPackages"
    url = uri("https://maven.pkg.github.com/Ahoo-Wang/CoCache")
    credentials {
        username = System.getenv("GITHUB_ACTOR")
        password = System.getenv("GITHUB_TOKEN")
    }
}

The github-deploy job publishes all publications:

yaml

# [package-deploy.yml:37-38](https://github.com/Ahoo-Wang/CoCache/blob/main/.github/workflows/package-deploy.yml#L37-L38)
- name: Publish package
  run: ./gradlew publishAllPublicationsToGitHubPackagesRepository

Consuming from GitHub Packages

kotlin

// build.gradle.kts (consumer project)
repositories {
    maven {
        url = uri("https://maven.pkg.github.com/Ahoo-Wang/CoCache")
        credentials {
            username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_ACTOR")
            password = project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN")
        }
    }
}

LinYi Packages

LinYi Packages is a private Maven repository. Configuration is read from gradle.properties (not committed to the repository):

kotlin

// [build.gradle.kts:145-152](https://github.com/Ahoo-Wang/CoCache/blob/main/build.gradle.kts#L145-L152)
maven {
    name = "LinYiPackages"
    url = uri(project.properties["linyiPackageReleaseUrl"].toString())
    credentials {
        username = project.properties["linyiPackageUsername"]?.toString()
        password = project.properties["linyiPackagePwd"]?.toString()
    }
}

These properties are expected to be defined in the developer's local ~/.gradle/gradle.properties or via environment variables:

Property	Description
`linyiPackageReleaseUrl`	Repository URL
`linyiPackageUsername`	Repository username
`linyiPackagePwd`	Repository password

Release Workflow

The complete release lifecycle from version bump to artifact availability:

mermaid

sequenceDiagram
autonumber
    participant Dev as Maintainer
    participant GP as gradle.properties
    participant GH as GitHub
    participant PD as package-deploy.yml
    participant GHP as GitHub Packages
    participant SNX as Sonatype Nexus
    participant MC as Maven Central

    Dev->>GP: Update version (e.g., 4.0.2 -> 4.1.0)
    Dev->>GH: Commit & push version change
    Dev->>GH: Create Release (tag: v4.1.0)
    GH->>PD: Trigger package-deploy.yml

    par github-deploy
        PD->>PD: Setup JDK 17
        PD->>GHP: ./gradlew publishAllPublicationsToGitHubPackagesRepository
        GHP-->>PD: Published
    and central-deploy
        PD->>PD: Setup JDK 17
        PD->>SNX: ./gradlew publishToSonatype
        SNX->>SNX: Stage artifacts
        PD->>SNX: closeAndReleaseSonatypeStagingRepository
        SNX->>MC: Validate & release
        MC-->>PD: Available (10-30 min)
    end

    GHP-->>Dev: Artifacts available immediately
    MC-->>Dev: Artifacts available after propagation

Step-by-Step Release Process

Update version in gradle.properties:
properties
```
version=4.1.0
```
1
Commit the version change and push to main
Create a GitHub Release with a tag matching v<version> (e.g., v4.1.0)
Wait for CI: The package-deploy.yml workflow triggers automatically
Verify artifacts appear on GitHub Packages and Maven Central

Local Publishing

For local development and testing, publish to the local Maven repository:

bash

# Publish all modules to ~/.m2/repository
./gradlew publishToMavenLocal

This publishes artifacts at version <current-version>-SNAPSHOT (or the exact version from gradle.properties) to ~/.m2/repository, allowing other local projects to consume the latest CoCache artifacts without a formal release.

Project Build Repository

A local build directory repository is also configured for build-time artifact exchange:

kotlin

// [build.gradle.kts:133-136](https://github.com/Ahoo-Wang/CoCache/blob/main/build.gradle.kts#L133-L136)
maven {
    name = "projectBuildRepo"
    url = uri(layout.buildDirectory.dir("repos"))
}

Publish to this repository with:

bash

./gradlew publishAllPublicationsToProjectBuildRepoRepository

Build & CI Overview -- Build system, Gradle setup, and quality tooling
Contributing Guide -- Code style, testing, and PR workflow
Modules -- Module architecture and responsibilities
Architecture -- System architecture overview

Publishing & Release ​

Publishing Targets ​

Published Modules ​

Maven Publication Structure ​

Version Management ​

PGP Signing ​

Required CI Secrets ​

Nexus Publishing (Maven Central) ​

Maven Central Requirements ​

GitHub Packages ​

Consuming from GitHub Packages ​

LinYi Packages ​

Release Workflow ​

Step-by-Step Release Process ​

Local Publishing ​

Project Build Repository ​

Related Pages ​

Publishing & Release

Publishing Targets

Published Modules

Maven Publication Structure

Version Management

PGP Signing

Required CI Secrets

Nexus Publishing (Maven Central)

Maven Central Requirements

GitHub Packages

Consuming from GitHub Packages

LinYi Packages

Release Workflow

Step-by-Step Release Process

Local Publishing

Project Build Repository

Related Pages