Blue-Falcon

Kotlin Multiplatform BLE library for iOS, Android, macos, windows and javascript

View the Project on GitHub Reedyuk/blue-falcon

Publishing Blue Falcon 3.0

This guide explains how to publish Blue Falcon 3.0 modules to Maven Central.

Prerequisites

1. Sonatype Account

You need a Sonatype account with access to the dev.bluefalcon group:

  1. Create account at https://central.sonatype.com/
  2. Request access to dev.bluefalcon namespace
  3. Wait for approval (usually 1-2 days)

2. GPG Key

Generate a GPG key for signing artifacts:

# Generate key
gpg --gen-key

# List keys to get the key ID
gpg --list-secret-keys --keyid-format=short

# Export the private key (for GitHub secrets)
gpg --armor --export-secret-keys YOUR_KEY_ID

# Export the public key and upload to keyserver
gpg --armor --export YOUR_KEY_ID | pbcopy
gpg --keyserver keyserver.ubuntu.com --send-keys YOUR_KEY_ID

3. Configure Secrets

GitHub Secrets (for CI/CD)

Add these secrets to your GitHub repository (Settings → Secrets and variables → Actions):

Local Properties (for local publishing)

Create/update library/local.properties:

# Maven Central credentials
mavenCentralUsername=your_username
mavenCentralPassword=your_password

# GPG signing
signingInMemoryKey=-----BEGIN PGP PRIVATE KEY BLOCK-----\n...\n-----END PGP PRIVATE KEY BLOCK-----
signingInMemoryKeyPassword=your_gpg_passphrase

⚠️ Never commit local.properties to version control!

Publishing Process

Automated (via GitHub Release)

The easiest way to publish is through GitHub releases:

  1. Create a git tag: 
    git tag v3.0.0
git push origin v3.0.0
  2. Create GitHub Release:
    • Go to GitHub → Releases → “Draft a new release”
    • Select your tag
    • Title: “Blue Falcon 3.0.0”
    • Description: Copy from docs/RELEASE_NOTES_3.0.0.md
    • Click “Publish release”
  3. GitHub Actions will:
    • Build all modules
    • Run tests
    • Sign artifacts
    • Publish to Maven Central
    • Automatically release (no manual promotion needed)

Manual (local)

For testing or manual releases:

cd library

# Publish to local Maven repository (for testing)
./gradlew publishToMavenLocal

# Publish to Maven Central
./gradlew publishAllPublicationsToMavenCentralRepository

# Or publish specific modules
./gradlew :core:publishAllPublicationsToMavenCentralRepository
./gradlew :engines:android:publishAllPublicationsToMavenCentralRepository
./gradlew :legacy:publishAllPublicationsToMavenCentralRepository

Published Artifacts

Blue Falcon 3.0 publishes 11 modules:

Core

Engines

Plugins

Legacy Compatibility

Version Management

Versions are centralized in library/gradle.properties:

version=3.0.0
versionCore=3.0.0
versionEngines=3.0.0
versionPlugins=3.0.0
versionLegacy=3.0.0

Version progression:

Verification

After publishing, verify artifacts are available:

Check Maven Central

Search: https://central.sonatype.com/search?q=dev.bluefalcon

Or use direct links:

Test in Project

// build.gradle.kts
dependencies {
    implementation("dev.bluefalcon:blue-falcon:3.0.0")
    // Should download successfully
}

Verify Signatures

# Download artifact
curl -O https://repo1.maven.org/maven2/dev/bluefalcon/blue-falcon-core/3.0.0/blue-falcon-core-3.0.0.jar
curl -O https://repo1.maven.org/maven2/dev/bluefalcon/blue-falcon-core/3.0.0/blue-falcon-core-3.0.0.jar.asc

# Verify signature
gpg --verify blue-falcon-core-3.0.0.jar.asc blue-falcon-core-3.0.0.jar

Troubleshooting

“Signing key not found”

Problem: Build fails with signing errors

Solution: Ensure secrets are set correctly:

# Check environment variables
echo $ORG_GRADLE_PROJECT_signingInMemoryKey
echo $ORG_GRADLE_PROJECT_signingInMemoryKeyPassword

# For local builds, check local.properties exists
cat library/local.properties

“Unauthorized” error

Problem: 401 Unauthorized when publishing

Solution: Check Maven Central credentials:

“Artifact already exists”

Problem: Cannot republish same version

Solution: Maven Central doesn’t allow overwriting. You must:

Artifact not appearing

Problem: Published but not showing on Maven Central

Solution:

Release Checklist

Before publishing a release:

After publishing:

Support

If you encounter issues:

  1. Check Sonatype Documentation
  2. Review GitHub Actions logs
  3. Open issue at https://github.com/Reedyuk/blue-falcon/issues

References