Skip to content

armgit / cua

Public Imported from GitHub
0

Scale computer-use 2.0 with open-source drivers, cross-OS sandboxes, and benchmarks for training, evaluation, and data generation.

ci(release): drop the generated synchronize commit when replaying a release branch onto main (#5696)

ddupont3bb603b18791
diff --git a/.github/scripts/replay_release_branch.sh b/.github/scripts/replay_release_branch.sh
new file mode 100755
index 0000000000..19b57e1e35
--- /dev/null
+++ b/.github/scripts/replay_release_branch.sh
@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+# Replay a Release Please branch (checked out) onto origin/main.
+#
+# replay_release_branch.sh REMOTE_BRANCH_REF [--component NAME ...]
+#
+# The branch carries Release Please's release commit and, after an earlier run,
+# a "chore(...): synchronize ..." commit with generated files. Replaying it can
+# stop on:
+# - the shared .release-please-manifest.json (every component PR rewrites it):
+# reconcile with merge_release_please_manifests.py, keeping main's versions
+# for other components and the --component version(s) owned by this PR;
+# - the generated "synchronize" commit (docs and lockfiles): drop it, because
+# the caller regenerates the same files right after the replay.
+# Anything else is a real conflict: abort and fail.
+set -euo pipefail
+
+REMOTE_BRANCH="${1:?remote branch ref, e.g. origin/release-please--...}"
+shift
+HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+TMP="${RUNNER_TEMP:-$(mktemp -d)}"
+
+in_rebase() { [[ -d "$(git rev-parse --git-path rebase-merge)" || -d "$(git rev-parse --git-path rebase-apply)" ]]; }
+
+if git rebase origin/main; then
+ exit 0
+fi
+
+for _ in $(seq 1 20); do
+ in_rebase || exit 0
+ CONFLICTS="$(git diff --name-only --diff-filter=U)"
+ SUBJECT="$(git log -1 --format=%s REBASE_HEAD 2>/dev/null || true)"
+ if [[ "$SUBJECT" =~ ^chore\(.*\):\ synchronize ]]; then
+ echo "Dropping the generated commit '$SUBJECT': it is regenerated after the replay"
+ git rebase --skip || true
+ elif [[ "$CONFLICTS" == ".release-please-manifest.json" ]]; then
+ git show origin/main:.release-please-manifest.json > "$TMP/main-release-manifest.json"
+ git show "$REMOTE_BRANCH:.release-please-manifest.json" > "$TMP/branch-release-manifest.json"
+ python3 "$HERE/merge_release_please_manifests.py" \
+ --main "$TMP/main-release-manifest.json" \
+ --release "$TMP/branch-release-manifest.json" \
+ ${@+"$@"} > .release-please-manifest.json
+ git add .release-please-manifest.json
+ GIT_EDITOR=true git rebase --continue || true
+ else
+ git rebase --abort
+ echo "::error::Release branch has conflicts beyond the shared manifest and generated files: $(echo $CONFLICTS)"
+ exit 1
+ fi
+done
+in_rebase && { git rebase --abort; echo "::error::Release branch replay did not finish"; exit 1; }
+exit 0
diff --git a/.github/scripts/tests/test_cua_driver_release_wiring.py b/.github/scripts/tests/test_cua_driver_release_wiring.py
index c086ed5d60..f7aa26985f 100644
--- a/.github/scripts/tests/test_cua_driver_release_wiring.py
+++ b/.github/scripts/tests/test_cua_driver_release_wiring.py
@@ -290,10 +290,14 @@ fi
'git fetch origin "+refs/heads/$BRANCH:refs/remotes/origin/$BRANCH"',
workflow,
)
- self.assertIn("git rebase origin/main", workflow)
- self.assertIn("merge_release_please_manifests.py", workflow)
- self.assertIn('git diff --name-only --diff-filter=U', workflow)
- self.assertIn("git rebase --abort", workflow)
+ # The replay onto main (manifest reconciliation, generated-commit drop,
+ # abort on a real conflict) lives in replay_release_branch.sh.
+ replay = (REPO_ROOT / ".github/scripts/replay_release_branch.sh").read_text()
+ self.assertIn("replay_release_branch.sh", workflow)
+ self.assertIn("git rebase origin/main", replay)
+ self.assertIn("merge_release_please_manifests.py", replay)
+ self.assertIn('git diff --name-only --diff-filter=U', replay)
+ self.assertIn("git rebase --abort", replay)
self.assertIn('--force-with-lease="refs/heads/$BRANCH:$REMOTE_HEAD"', workflow)
self.assertNotIn("git push --force ", workflow)
self.assertIn("sync_driver_release_docs.py", workflow)
diff --git a/.github/scripts/tests/test_replay_release_branch.py b/.github/scripts/tests/test_replay_release_branch.py
new file mode 100644
index 0000000000..4e64c04c0c
--- /dev/null
+++ b/.github/scripts/tests/test_replay_release_branch.py
@@ -0,0 +1,97 @@
+import json
+import os
+import shutil
+import subprocess
+import tempfile
+import unittest
+from pathlib import Path
+
+SCRIPTS = Path(__file__).resolve().parents[1]
+SB = "libs/python/cua-sandbox"
+
+
+def git(cwd, *args, check=True):
+ env = dict(os.environ, GIT_AUTHOR_NAME="t", GIT_AUTHOR_EMAIL="t@t", GIT_COMMITTER_NAME="t", GIT_COMMITTER_EMAIL="t@t")
+ return subprocess.run(["git", *args], cwd=cwd, env=env, check=check, capture_output=True, text=True)
+
+
+def write(repo, rel, text):
+ path = repo / rel
+ path.parent.mkdir(parents=True, exist_ok=True)
+ path.write_text(text)
+
+
+class ReplayReleaseBranch(unittest.TestCase):
+ def setUp(self):
+ self.tmp = Path(tempfile.mkdtemp())
+ self.addCleanup(shutil.rmtree, self.tmp, True)
+ self.repo = self.tmp / "repo"
+ self.repo.mkdir()
+ git(self.repo, "init", "-q", "-b", "main")
+ for name in ("replay_release_branch.sh", "merge_release_please_manifests.py"):
+ dest = self.repo / ".github/scripts" / name
+ dest.parent.mkdir(parents=True, exist_ok=True)
+ shutil.copy(SCRIPTS / name, dest)
+ write(self.repo, ".release-please-manifest.json", json.dumps({SB: "0.9.1", "libs/cua": "0.5.0"}, indent=2) + "\n")
+ write(self.repo, "docs/gen.mdx", "version 0.9.1\n")
+ git(self.repo, "add", "-A")
+ git(self.repo, "commit", "-qm", "base")
+ git(self.repo, "checkout", "-qb", "release")
+ write(self.repo, ".release-please-manifest.json", json.dumps({SB: "0.9.2", "libs/cua": "0.5.0"}, indent=2) + "\n")
+ git(self.repo, "commit", "-qam", "chore(main): release sandbox 0.9.2")
+ write(self.repo, "docs/gen.mdx", "version 0.9.2\n")
+ git(self.repo, "commit", "-qam", "chore(sandbox): synchronize release metadata")
+ git(self.repo, "checkout", "-q", "main")
+
+ def advance_main(self, manifest, doc):
+ write(self.repo, ".release-please-manifest.json", json.dumps(manifest, indent=2) + "\n")
+ write(self.repo, "docs/gen.mdx", doc)
+ git(self.repo, "commit", "-qam", "main moves")
+ # the workflow's remote refs
+ git(self.repo, "update-ref", "refs/remotes/origin/main", "main")
+ git(self.repo, "update-ref", "refs/remotes/origin/release", "release")
+ git(self.repo, "checkout", "-q", "release")
+
+ def run_script(self):
+ return subprocess.run(
+ [str(self.repo / ".github/scripts/replay_release_branch.sh"), "origin/release", "--component", "sandbox"],
+ cwd=self.repo, capture_output=True, text=True,
+ env=dict(os.environ, RUNNER_TEMP=str(self.tmp), GIT_EDITOR="true",
+ GIT_AUTHOR_NAME="t", GIT_AUTHOR_EMAIL="t@t", GIT_COMMITTER_NAME="t", GIT_COMMITTER_EMAIL="t@t"),
+ )
+
+ def test_manifest_and_generated_commit_both_conflict(self):
+ # main bumped another component AND regenerated the same doc.
+ self.advance_main({SB: "0.9.1", "libs/cua": "0.6.0"}, "version 0.9.1 and more\n")
+ result = self.run_script()
+ self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
+ manifest = json.loads((self.repo / ".release-please-manifest.json").read_text())
+ self.assertEqual(manifest, {SB: "0.9.2", "libs/cua": "0.6.0"})
+ # the generated commit was dropped; main's doc stays for the caller to regenerate
+ self.assertEqual((self.repo / "docs/gen.mdx").read_text(), "version 0.9.1 and more\n")
+ self.assertEqual(git(self.repo, "log", "--format=%s", "origin/main..HEAD").stdout.strip(),
+ "chore(main): release sandbox 0.9.2")
+
+ def test_real_conflict_fails(self):
+ self.advance_main({SB: "0.9.1", "libs/cua": "0.6.0"}, "x\n")
+ # a hand edit in the release commit that conflicts with main outside the manifest
+ git(self.repo, "checkout", "-q", "release")
+ git(self.repo, "reset", "-q", "--hard", "HEAD~1")
+ write(self.repo, "README.md", "release edit\n")
+ git(self.repo, "add", "-A")
+ git(self.repo, "commit", "-qm", "chore(main): release sandbox 0.9.2 edit")
+ git(self.repo, "checkout", "-q", "main")
+ write(self.repo, "README.md", "main edit\n")
+ git(self.repo, "add", "-A")
+ git(self.repo, "commit", "-qm", "main readme")
+ git(self.repo, "update-ref", "refs/remotes/origin/main", "main")
+ git(self.repo, "update-ref", "refs/remotes/origin/release", "release")
+ git(self.repo, "checkout", "-q", "release")
+ result = self.run_script()
+ self.assertNotEqual(result.returncode, 0)
+ self.assertIn("conflicts beyond", result.stdout + result.stderr)
+ self.assertFalse((self.repo / ".git/rebase-merge").exists())
+
+
+if __name__ == "__main__":
+ unittest.main()
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
index a7f570e799..344ab1836f 100644
--- a/.github/workflows/release-please.yml
+++ b/.github/workflows/release-please.yml
@@ -209,52 +209,29 @@ jobs:
git config user.email "trycua-release[bot]@users.noreply.github.com"
if [[ "$DECISION" == keep* ]]; then
echo "Leaving the release branch and its checks alone"
- elif ! git rebase origin/main; then
- mapfile -t CONFLICTS < <(git diff --name-only --diff-filter=U)
- if [[ "${#CONFLICTS[@]}" -ne 1 || \
- "${CONFLICTS[0]}" != ".release-please-manifest.json" ]]; then
- git rebase --abort
- echo "::error::Release branch has conflicts beyond the shared manifest"
- exit 1
- fi
-
- # Each component release PR rewrites the shared manifest from
- # its original base. Keep main's versions for other components
- # and carry forward only the version(s) owned by this PR.
- git show origin/main:.release-please-manifest.json \
- > "$RUNNER_TEMP/main-release-manifest.json"
- git show "origin/$BRANCH:.release-please-manifest.json" \
- > "$RUNNER_TEMP/branch-release-manifest.json"
+ else
+ # Replay onto main: reconcile the shared manifest and drop the
+ # generated "synchronize" commit (regenerated below).
COMPONENT_ARGS=()
- if [[ "$DRIVER" == "true" ]]; then
+ if [[ "${DRIVER}" == "true" ]]; then
COMPONENT_ARGS+=(--component cua-driver-rs)
fi
- if [[ "$PERCEPTION" == "true" ]]; then
+ if [[ "${PERCEPTION}" == "true" ]]; then
COMPONENT_ARGS+=(--component cua-perception)
fi
- if [[ "$LUME" == "true" ]]; then
+ if [[ "${LUME}" == "true" ]]; then
COMPONENT_ARGS+=(--component lume)
fi
- if [[ "$SANDBOX" == "true" ]]; then
+ if [[ "${SANDBOX}" == "true" ]]; then
COMPONENT_ARGS+=(--component sandbox)
fi
- if [[ "$SPACESD" == "true" ]]; then
+ if [[ "${SPACESD}" == "true" ]]; then
COMPONENT_ARGS+=(--component cua-spacesd)
fi
- if [[ "$SDK" == "true" ]]; then
+ if [[ "${SDK}" == "true" ]]; then
COMPONENT_ARGS+=(--component cua-sdk)
fi
- python3 .github/scripts/merge_release_please_manifests.py \
- --main "$RUNNER_TEMP/main-release-manifest.json" \
- --release "$RUNNER_TEMP/branch-release-manifest.json" \
- "${COMPONENT_ARGS[@]}" \
- > .release-please-manifest.json
- git add .release-please-manifest.json
- if ! GIT_EDITOR=true git rebase --continue; then
- git rebase --abort
- echo "::error::Release branch still conflicts after manifest reconciliation"
- exit 1
- fi
+ .github/scripts/replay_release_branch.sh "origin/$BRANCH" "${COMPONENT_ARGS[@]}"
fi
if [[ "$PERCEPTION" == "true" ]]; then
PERCEPTION_VERSION=$(tr -d '[:space:]' < \