rluvaton commented on code in PR #21499: URL: https://github.com/apache/datafusion/pull/21499#discussion_r3154558919
########## ci/scripts/changed_crates.sh: ########## @@ -0,0 +1,138 @@ +#!/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. +# +# 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. +# +# comment <repo> <pr_number> <check_result> [logs] +# Upsert or delete a sticky PR comment based on check_result. +# check_result: "success" deletes any existing comment, +# anything else upserts the comment with the provided logs. +# Requires GH_TOKEN to be set. + +set -euo pipefail + +MARKER="<!-- semver-check-comment -->" + +# ── 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 internal crates without a manual exclusion list. + local crates + crates=$(cargo metadata --no-deps --format-version 1 | jq -r ' + (.workspace_root + "/") as $root + | .packages[] + | select(.publish != []) + | "\(.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 --baseline-rev "$base_ref" "${args[@]}" +} + +# ── comment ───────────────────────────────────────────────────────── +cmd_comment() { + local repo="${1:?Usage: changed_crates.sh comment <repo> <pr_number> <check_result> [logs]}" + local pr_number="${2:?}" + local check_result="${3:?}" + local logs="${4:-}" + + # Find existing comment with our marker + local comment_id + comment_id=$(gh api "repos/${repo}/issues/${pr_number}/comments" \ + --jq ".[] | select(.body | contains(\"${MARKER}\")) | .id" | head -1) + + echo "existing breaking change comment id $comment_id" + + if [ "$check_result" = "success" ]; then + # Delete the comment if one exists + if [ -n "$comment_id" ]; then + echo "result is success, so deleting breaking change comment" + gh api "repos/${repo}/issues/comments/${comment_id}" --method DELETE + else + echo "result is success and no previous comment to delete" + fi + else + local body="${MARKER} +Thank you for opening this pull request! + +Reviewer note: [cargo-semver-checks](https://github.com/obi1kenobi/cargo-semver-checks) reported the current version number is not SemVer-compatible with the changes made since the last release. Review Comment: Compared against base branch since it might depend on another breaking change earlier made -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
