pluginManagement {
  repositories {
    mavenCentral()
  }
  plugins {
    id("com.fueledbycaffeine.spotlight") version "<latest>"
    id("xyz.block.artifactswap.settings") version "<latest>"
  }
}
plugins {
  // Required to be declared here, but artifact swap will apply it for you
  id("com.fueledbycaffeine.spotlight") apply false
  id("xyz.block.artifactswap.settings")
}

# Primary repository name in your artifact management system
artifactswap.primaryRepositoryName=my-company-artifacts
# Maven group ID for your internal artifacts
artifactswap.primaryArtifactsMavenGroup=com.mycompany.artifactswap.artifacts
# Git branch name where BOM versions are published
artifactswap.bomSourceBranchName=origin/artifact-swap-green-main
# Base URL for your Artifactory instance
artifactswap.artifactoryBaseUrl=https://artifactory.mycompany.com
# Token file name for Artifactory authentication (used in CI)
artifactswap.artifactoryPublisherTokenFileName=artifactory-token.txt

artifactSwap {
  // Enable/disable artifact swap
  enabled(true)
  // Or use a provider for dynamic configuration
  enabled(providers.gradleProperty("artifactswap.enabled").map { it.toBoolean() })
}

# Download the CLI distribution
VERSION="<latest>"
curl -L "https://repo.maven.apache.org/maven2/xyz/block/artifactswap/cli/$VERSION/cli-$VERSION.zip" -o artifactswap.zip
# Extract to your tools directory
mkdir -p tools/artifactswap
unzip artifactswap.zip -d tools/artifactswap

# Clone and build
git clone https://github.com/block/artifact-swap.git
cd artifact-swap
./gradlew :cli:publishToMavenLocal
# Extract from maven local
VERSION=$(grep "^version=" gradle.properties | cut -d'=' -f2)
cd ~/.m2/repository/xyz/block/artifactswap/cli/$VERSION
unzip cli-$VERSION.zip -d ~/Development/your-project/tools/artifactswap

#!/bin/bash
set -o errexit
set -o pipefail
set -o nounset
git_root=$(git rev-parse --show-toplevel)
tools_root="$git_root/tools"
branch=artifact-swap-green-main  # Your BOM branch name
# Attempt to fetch BOM branch
if ! git fetch origin $branch --quiet 2>/dev/null; then
  git update-ref -d refs/remotes/origin/$branch 2>/dev/null || true
  git fetch origin $branch --quiet 2>/dev/null || true
fi
# Ensure the reference exists after fetch
if ! git show-ref --verify --quiet refs/remotes/origin/$branch; then
  git update-ref refs/remotes/origin/$branch FETCH_HEAD
fi
echo "Syncing artifacts for Artifact Swap"
"$tools_root/artifactswap/artifactswap-$VERSION/bin/artifactswap" download-artifacts "$@"

chmod +x scripts/artifact-swap/download-artifacts.sh

# In your project root
cat > .git/hooks/post-checkout << 'EOF'
#!/bin/bash
./scripts/artifact-swap/download-artifacts.sh > /dev/null 2>&1 & disown
EOF
# Or just add the above command to an existing post-checkout hook
chmod +x .git/hooks/post-checkout

./scripts/artifact-swap/download-artifacts.sh --logging debug

artifactswap.enabled=false

artifactswap.publishingEnabled=true

Important

All your build plugins must be loaded in the settings classpath for this to work

// build-logic build.gradle(.kts)
dependencies {
  implementation("xyz.block.artifactswap:gradle-publish-plugin:<latest>")
}

// Your build-logic library plugin(s)
class MyLibraryPlugin : Plugin<Project> {
  override fun apply(target: Project) = target.run {
    // ...
    pluginManager.apply(ArtifactSwapProjectPublishPlugin::class.java)
  }
}

# Artifact repository URL for publishing
artifactswap.artifactRepo.url=https://artifactory.mycompany.com/artifactory/my-repo
# Credentials for publishing (typically set via environment variables in CI)
# artifactswap.artifactRepo.username=publisher
# artifactswap.artifactRepo.password=secret

#!/usr/bin/env bash
set -o errexit
set -o pipefail
set -o nounset
# Allocate memory to prevent OOM crashes
export ARTIFACTSWAP_TOOL_OPTS="-Xmx3072M"
# Configure your CI pipeline to save this artifact for use in the BOM publishing stage
export ARTIFACTSWAP_HASHING_FILE=artifactswapHashes/artifactswapHashing.out
export ARTIFACTSWAP_GRADLE_MAX_MEMORY=17408
# 1. Hash all files to determine which modules have changed
echo "===== Hashing Files ====="
tools/artifactswap/artifactswap hashing \
  --logging debug \
  --hashing-output-file "${ARTIFACTSWAP_HASHING_FILE}" \
  --gradle-max-memory ${ARTIFACTSWAP_GRADLE_MAX_MEMORY} \
  --gradle-jvm-args "-XX:MaxMetaspaceSize=1g" \
  --log-gradle
# 2. Find the publish tasks that need to run
echo "===== Finding Tasks to Publish ====="
tools/artifactswap/artifactswap task-finder \
  --logging debug \
  --gradle-max-memory ${ARTIFACTSWAP_GRADLE_MAX_MEMORY} \
  --gradle-args "-Partifactswap.publishingEnabled=true -Partifactswap.artifactVersionFile=${ARTIFACTSWAP_HASHING_FILE}" \
  --gradle-jvm-args "-XX:MaxMetaspaceSize=1g" \
  --task-list-output-directory "taskOutputs" \
  --task publishToArtifactSwapRepository \
  --log-gradle \
  --output-mode "SINGLE_TASK_LIST"
# 3. Check which artifacts already exist in Artifactory
echo "===== Checking Artifacts ====="
tools/artifactswap/artifactswap artifact-checker \
  --logging debug \
  --hash-file "${ARTIFACTSWAP_HASHING_FILE}" \
  --input-file "taskOutputs/task-output.out" \
  --output-file "taskOutputs/task-output-filtered.out"
# 4. Publish only the artifacts that don't already exist
echo "===== Publishing Artifacts ====="
tools/artifactswap/artifactswap task-runner \
  --logging debug \
  --gradle-max-memory ${ARTIFACTSWAP_GRADLE_MAX_MEMORY} \
  --gradle-args "-Partifactswap.publishingEnabled=true -Partifactswap.artifactVersionFile=${ARTIFACTSWAP_HASHING_FILE}" \
  --gradle-jvm-args "-XX:MaxMetaspaceSize=1g" \
  --task-list-file "taskOutputs/task-output-filtered.out" \
  --log-gradle

#!/usr/bin/env bash
set -o errexit
set -o pipefail
set -o nounset
export ARTIFACTSWAP_TOOL_OPTS="-Xmx3072M"
# This file should be consumed as an artifact from the previous pipeline stage
export ARTIFACTSWAP_HASHING_FILE=artifactswapHashes/artifactswapHashing.out
export BOM_BRANCH=artifact-swap-green-main  # Your BOM branch name from gradle.properties
echo "===== Publishing BOM ====="
tools/artifactswap/artifactswap bom-publisher \
  --logging debug \
  --bom-version "${GIT_COMMIT}" \
  --hash-file-location "${ARTIFACTSWAP_HASHING_FILE}"
echo "===== Updating BOM Branch ====="
# Update the BOM tracking branch to point to the current commit
# This allows developers to find the most recent BOM for their branch
git fetch origin "${BOM_BRANCH}" || true
git branch -f "${BOM_BRANCH}" "${GIT_COMMIT}"
git push origin "${BOM_BRANCH}"

Tip

Configure your CI pipeline to only run the BOM publishing job after all your other check tasks have completed successfully. This will prevent compilation issues from "poisoning" the IDE artifacts.