ci/scripts/changed_crates.sh

#!/usr/bin/env bash
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

# Helper script for the breaking-changes-detector workflow.
#
# Subcommands:
#   changed-crates <base_ref>
#       Print space-separated list of crate names whose files changed vs base_ref.
#       Only published workspace members (those without `publish = false`)
#       are considered. We also omit datafusion-sqllogictest. It is published
#       so that other projects can write tests with DataFusion's sqllogictest
#       driver, but it is test tooling rather than part of DataFusion's
#       library API. It also depends on nearly every other DataFusion crate,
#       so checking it usually takes most of the job's time.
#
#   semver-check <base_ref> <packages...>
#       Run cargo-semver-checks for the given packages against base_ref.
#       Output and exit code are passed through unchanged; the caller is
#       responsible for capturing/formatting them.

set -euo pipefail

# ── changed-crates ──────────────────────────────────────────────────
cmd_changed_crates() {
  local base_ref="${1:?Usage: changed_crates.sh changed-crates <base_ref>}"

  # 1. Files changed between the PR and the base branch.
  local changed_files
  changed_files=$(git diff --name-only "${base_ref}...HEAD")

  # 2. Every publishable workspace member, one per line as
  #    "<crate-name> <crate-dir>". `publish = false` in Cargo.toml shows
  #    up as `"publish": []` in cargo metadata, so filtering on that
  #    excludes unpublished crates. datafusion-sqllogictest is excluded by
  #    name; see the comment at the top of this file.
  local crates
  crates=$(cargo metadata --no-deps --format-version 1 | jq -r '
    (.workspace_root + "/") as $root
    | .packages[]
    | select(.publish != [] and .name != "datafusion-sqllogictest")
    | "\(.name) \(.manifest_path | ltrimstr($root) | rtrimstr("/Cargo.toml"))"
  ')

  # 3. Keep crates whose directory contains a changed file.
  while read -r name dir; do
    if grep -q "^${dir}/" <<<"$changed_files"; then
      echo "$name"
    fi
  done <<<"$crates" | xargs
}

# ── semver-check ────────────────────────────────────────────────────
cmd_semver_check() {
  local base_ref="${1:?Usage: changed_crates.sh semver-check <base_ref> <packages...>}"
  shift

  local args=()
  for pkg in "$@"; do
    args+=(--package "$pkg")
  done

  # cargo-semver-checks builds the rustdoc for each crate, current and
  # baseline, in a separate placeholder project. Each project has its own
  # target directory unless CARGO_TARGET_DIR is set, so a shared directory
  # lets those builds reuse the compiled dependencies.
  local target_dir
  target_dir=$(cargo metadata --no-deps --format-version 1 | jq -r .target_directory)

  CARGO_TARGET_DIR="${target_dir}/semver-checks-shared" \
    cargo semver-checks --baseline-rev "$base_ref" "${args[@]}"
}

# ── main ────────────────────────────────────────────────────────────
cmd="${1:?Usage: changed_crates.sh <changed-crates|semver-check> [args...]}"
shift

case "$cmd" in
  changed-crates) cmd_changed_crates "$@" ;;
  semver-check)   cmd_semver_check "$@" ;;
  *) echo "Unknown command: $cmd" >&2; exit 1 ;;
esac