PUBLISHING.md

MapConductor Publishing Guide

This document explains how to publish MapConductor modules to various Maven repositories.

Available Modules

The following modules are configured for publishing:

• mapconductor-bom - Versioning dependency modules
• core - Core abstractions and shared functionality
• for-arcgis - ArcGIS Maps implementation
• for-googlemaps - Google Maps implementation
• for-here - HERE Maps implementation
• for-mapbox - Mapbox implementation
• icons - Reusable marker icon components

Publishing Destinations

1. Local Maven Repository (Testing)

For local testing and development:

# Publish all modules to local repository
./gradlew publishAllLocal

# Publish individual module
./gradlew :android-sdk-core:publishToMavenLocal

Published artifacts will be available in ~/.m2/repository/com/mapconductor/

2. GitHub Packages

For publishing to GitHub Packages repository:

Setup GitHub Credentials

Add to local.properties or set environment variables:

# local.properties
gpr.user=your-github-username
gpr.key=your-github-personal-access-token

Or set environment variables:

export GITHUB_ACTOR=your-github-username
export GITHUB_TOKEN=your-github-personal-access-token

Publish to GitHub

# Publish all modules to GitHub Packages
./gradlew publishAllToGitHub

# Publish individual module
./gradlew :android-sdk-core:publishReleasePublicationToGitHubPackagesRepository

3. Maven Central (Central Portal)

For publishing to Maven Central via the new Central Portal:

Setup Central Portal Credentials

Add to local.properties or set environment variables:

# local.properties
signing.keyId=your-gpg-key-id
signing.password=your-gpg-key-password
signing.secretKeyRingFile=/path/to/secring.gpg
ossrh.username=your-central-portal-username
ossrh.password=your-central-portal-password

Or set environment variables:

export OSSRH_USERNAME=your-central-portal-username
export OSSRH_PASSWORD=your-central-portal-password

Publish to Maven Central

# Step 1: Stage all modules locally (prepare for Central Portal)
./gradlew publishAllToMavenCentral

# Step 2: Submit to Central Portal
./gradlew publishAllPublicationsToCentralPortal

# For individual module submissions
./gradlew :android-sdk-core:publishReleasePublicationToCentralPortal

Verification

Check your submission at https://central.sonatype.com/

• Login with your Central Portal credentials
• View deployments to see status
• Artifacts will appear on Maven Central after successful validation

Configuration

Version Management

Update version in gradle.properties:

libraryVersion=1.0.1

Note: versionName is no longer used for library publishing. Only libraryVersion is needed.

Library Metadata

Configure in gradle.properties:

libraryGroupId=com.mapconductor
libraryUrl=https://github.com/mapconductor/android-sdk-doc
developerId=mapconductor
developerName=MapConductor Team
developerEmail=dev@mapconductor.com
scmUrl=https://github.com/mapconductor/android-sdk-doc.git

Module-Specific Configuration

Each module has its own artifact ID and description in its build.gradle.kts:

ext {
    libraryArtifactId = "core"
    libraryName = "MapConductor Core"
    libraryDescription = "Core abstractions and shared functionality for MapConductor unified mapping library"
}

Generated Artifacts

Each module publishes the following artifacts:

• {artifact-id}-{version}.aar - Main library
• {artifact-id}-{version}-sources.jar - Source code
• {artifact-id}-{version}-javadoc.jar - Documentation
• {artifact-id}-{version}.pom - Maven metadata

Usage in Other Projects

With GitHub Packages

repositories {
    maven {
        name = "GitHubPackages"
        url = uri("https://maven.pkg.github.com/mapconductor/android-sdk")
        credentials {
            username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_ACTOR")
            password = project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN")
        }
    }
}

dependencies {
    implementation("com.mapconductor:mapconductor-bom:1.0.0")
    implementation("com.mapconductor:core")
    implementation("com.mapconductor:for-googlemaps")
    // Add other modules as needed
}

With Maven Central

dependencies {
    implementation("com.mapconductor:mapconductor-bom:1.0.0")
    implementation("com.mapconductor:core")
    implementation("com.mapconductor:for-googlemaps")
    // Add other modules as needed
}

Troubleshooting

Common Issues

1. Authentication Failed: Verify Central Portal credentials in local.properties or environment variables
2. Signing Failed: Ensure GPG key is properly configured for Maven Central
3. Build Failed: Run ./gradlew allLintChecks to fix code style issues first
4. Version Shows as "unspecified": Check that libraryVersion is properly set in gradle.properties
5. Central Portal Submission Failed: Use ./gradlew publishAllPublicationsToCentralPortal --info for detailed logs

Verifying Artifacts

Check generated artifacts before publishing:

# Build all modules
./gradlew build

# Check artifacts in build/outputs/aar/
ls android-sdk-core/build/outputs/aar/

Clean Build

If you encounter issues, try a clean build:

./gradlew clean
./gradlew build
./gradlew publishAllLocal

Release Checklist

Before publishing a release:

1. Update libraryVersion in gradle.properties
2. Run ./gradlew allLintChecks and fix any issues
3. Run ./gradlew build and ensure all tests pass
4. Test locally with ./gradlew publishAllLocal
5. Update CHANGELOG.md with release notes
6. Create git tag: git tag v1.0.0
7. Stage artifacts: ./gradlew publishAllToMavenCentral
8. Submit to Central Portal: ./gradlew publishAllPublicationsToCentralPortal
9. Verify submission at https://central.sonatype.com/
10. Push tag: git push origin v1.0.0