Skip to content

Use a Scala Steward hook to update the runtime google-java-format mapping #273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mkurz merged 1 commit into from
Apr 16, 2026
+46 −5
Merged

Use a Scala Steward hook to update the runtime google-java-format mapping #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions .scala-steward.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
// really slow dependency updates, please
pullRequests.frequency = "90 days"

updates.pin = [
// Releases after 1.24.x require JDK 17
// https://github.com/google/google-java-format/releases/tag/v1.25.0
{ groupId = "com.google.googlejavaformat", artifactId = "google-java-format", version = "1.24." }
]
commits.message = "bump: ${artifactName} ${nextVersion} (was ${currentVersion})"

postUpdateHooks = [
{
groupId = "com.google.googlejavaformat"
artifactId = "google-java-format"
command = ["bash", "scripts/update-google-java-format-runtime.sh"]
commitMessage = "Update google-java-format runtime mapping"
}
]
37 changes: 37 additions & 0 deletions scripts/update-google-java-format-runtime.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#!/usr/bin/env bash

set -euo pipefail

repo_root="$(cd "$(dirname "$0")/.." && pwd)"
build_file="$repo_root/build.sbt"
plugin_file="$repo_root/plugin/src/main/scala/com/github/sbt/JavaFormatterPlugin.scala"
readme_file="$repo_root/README.md"

compile_api_version="1.24.0"

# Assumption:
# the latest google-java-format release continues to belong to the Java 21
# compatibility bucket. If upstream raises the runtime requirement again,
# update this hook and the compatibility mapping policy.

extract_version() {
sed -n 's/.*"com\.google\.googlejavaformat" % "google-java-format" % "\([^"]*\)".*/\1/p' "$build_file" | head -n1
}

detected_version="$(extract_version)"

if [[ -z "$detected_version" ]]; then
echo "Could not determine google-java-format version from $build_file" >&2
exit 1
fi

if [[ "$detected_version" == "$compile_api_version" ]]; then
echo "google-java-format compile API version is unchanged at $compile_api_version; nothing to rewrite."
exit 0
fi

perl -0pi -e 's/"com\.google\.googlejavaformat" % "google-java-format" % "[^"]*"/"com.google.googlejavaformat" % "google-java-format" % "'"$compile_api_version"'"/' "$build_file"
perl -0pi -e 's/case 21\s*=> "\Q'"$detected_version"'\E"|case 21\s*=> "[^"]*"/case 21 => "'"$detected_version"'"/' "$plugin_file"
perl -0pi -e 's/- `21` -> `google-java-format [^`]*`/- `21` -> `google-java-format '"$detected_version"'`/' "$readme_file"

echo "Updated runtime google-java-format version to $detected_version and restored build.sbt to $compile_api_version."