Skip to content

migration-from-scripts.md

Latest commit

 

History

History
88 lines (69 loc) · 3.47 KB

migration-from-scripts.md

File metadata and controls

88 lines (69 loc) · 3.47 KB
Raw

Migration: bb4-gradle 1.x scripts → 2.x plugins

Summary

1.x 2.x
buildscript + classpath 'com.barrybecker4:bb4-gradle:…' pluginManagement + plugins { id("com.barrybecker4.bb4.…") version "…" }
apply from: …getResource('bb4.gradle') id("com.barrybecker4.bb4.scala-library") (and optionally bb4.base is applied inside scala-library)
apply from: …'bb4-publish.gradle' id("com.barrybecker4.bb4.publish")
apply from: …'bb4-deploy.gradle' id("com.barrybecker4.bb4.application")
Java 17 / Scala 3.3.x defaults Java 21 / Scala 3.8.2 defaults (override via bb4 { scalaVersion.set("…") })

Before (1.x)

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'com.barrybecker4:bb4-gradle:1.9.0'
    }
}

apply from: project.buildscript.classLoader.getResource('bb4.gradle').toURI()
// … project-specific config …
apply from: project.buildscript.classLoader.getResource('bb4-publish.gradle').toURI()
apply from: project.buildscript.classLoader.getResource('bb4-deploy.gradle').toURI()

After (2.x)

settings.gradle (or .kts):

pluginManagement {
    repositories {
        gradlePluginPortal()
        mavenCentral()
        // Only needed when consuming a -SNAPSHOT plugin build:
        // maven { url 'https://central.sonatype.com/repository/maven-snapshots/' }
    }
}

build.gradle:

plugins {
    id 'com.barrybecker4.bb4.scala-library' version '2.0.0'
    id 'com.barrybecker4.bb4.publish' version '2.0.0'      // if publishing
    id 'com.barrybecker4.bb4.application' version '2.0.0' // if using app + deploy*
}

bb4 {
    archivesBaseName.set('my-lib')
    mainClass.set('com.example.Main')  // if applicable
}

// Remove duplicate declarations now provided by plugins:
// - scala-library, java-library, repositories (unless you need extras)
// - scala3-library / scalatest / junit / vecmath (unless you need different versions)

Canary rollout (one repository at a time)

  1. Publish bb4-gradle 2.x to Maven local or Sonatype snapshot: ./gradlew publishToMavenLocal or publishArtifacts.
  2. In one downstream repo:
    • Upgrade Gradle wrapper to 8.14.3 (or the version in bb4-gradle’s gradle-wrapper.properties).
    • Replace buildscript / apply from with plugins { } as above.
    • Delete redundant dependencies / compileOptions that duplicate plugin defaults.
    • Run ./gradlew clean test jar (and distZip / run for apps).
    • If publishing a release (non-SNAPSHOT): after ./gradlew publish, run the Staging API promote curl and click Publish in the Central Portal — see docs/publishing-sonatype.md. Same process as releasing bb4-gradle.
  3. Repeat for each bb4 repo (libraries first, then applications).

Compatibility matrix (2.x)

bb4-gradle Gradle Java Scala (default)
2.0.x 8.14+ 21 3.8.2

jarMap (multi-jar publications)

Still supported when bb4.publish is applied: set ext.jarMap (or jarMap in gradle.properties / extension) before tasks resolve, same shape as 1.x (keys → maps with include, optional exclude). Prefer doing this in a gradle.afterProject or early in build.gradle so publications are created consistently.

If you hit ordering issues, open an issue or split modules instead of jarMap for long-term simplicity.