ci: Update bump-version workflow to regenerate snapshot tests (#552)

* ci: Update bump-version workflow to regenerate snapshot tests

The bump-version workflow now includes:
1. Verification that pyproject.toml has exactly one line changed
2. A step to update snapshot tests when bumping the version
3. Verification that each snapshot SVG file has exactly one line changed

This ensures that version bumps are clean and only affect the version
string in pyproject.toml and the splash screen version in snapshot files.

Changes:
- Add verification that pyproject.toml diff has exactly 1 line change
- Add 'Update snapshot tests' step that runs pytest with --snapshot-update
- Add 'Verify snapshot diffs' step to check each SVG has exactly 1 line diff
- Stage tests/snapshots/ files in the commit step
- Update PR description to show diff verification status

Co-authored-by: openhands <openhands@all-hands.dev>

* fix: Remove || true from pytest to not hide snapshot failures

Removing the error suppression ensures the workflow fails if snapshot
regeneration encounters any issues, preventing broken state from being
committed.

* refactor: Remove unused PYPROJECT_DIFF_ESCAPED variable

The variable was captured and exported to env but never used - the PR
body uses a hardcoded template instead. Removing dead code to reduce
complexity.

* refactor: Rename LINES_CHANGED to DIFF_LINES in pyproject.toml check

The variable name now accurately reflects what it measures - the numstat
total (added + deleted lines), not logical lines changed. Also improved
the log message to clarify the expectation.

* refactor: Rename LINES_CHANGED to DIFF_LINES in snapshot verification

For consistency with the pyproject.toml check, renamed the variable to
accurately reflect what it measures - the numstat total (added + deleted).
Also improved log messages to clarify the diff lines terminology.

* fix: Replace brittle line-count check with version value verification

Instead of checking that exactly 1 line changed (which fails in
legitimate scenarios like updating dependencies during release),
verify that the version field has the expected value. This checks
what matters, not how many lines changed.

* fix: Remove brittle snapshot diff verification step

The per-file diff line check was over-specified and would break when:
- pytest-textual-snapshot changes SVG generation formatting
- Version string appears in multiple SVG elements
- Whitespace normalization occurs

The workflow already runs snapshot tests - if they're broken, the tests
will fail. Trust the actual test run to catch broken snapshots instead
of over-specifying validation based on implementation details.

---------

Co-authored-by: openhands <openhands@all-hands.dev>

Author: malhotra5

.github/workflows/bump-version.yml

@@ -64,9 +64,13 @@ jobs:
                   # Update version in pyproject.toml
                   sed -i "s/^version = \"$CURRENT_VERSION\"/version = \"$VERSION\"/" pyproject.toml
 
-                  # Verify the change was made
-                  echo "Updated version line:"
-                  grep '^version = ' pyproject.toml
+                  # Verify the version field has the expected value
+                  ACTUAL_VERSION=$(grep "^version = " pyproject.toml | sed -E 's/version = "(.+)"/\1/')
+                  if [ "$ACTUAL_VERSION" != "$VERSION" ]; then
+                    echo "❌ Error: Version in pyproject.toml is $ACTUAL_VERSION, expected $VERSION"
+                    exit 1
+                  fi
+                  echo "✅ Verified: pyproject.toml version is $VERSION"
 
                   echo "current_version=$CURRENT_VERSION" >> $GITHUB_ENV
                   echo "branch_name=$BRANCH_NAME" >> $GITHUB_ENV
@@ -83,24 +87,41 @@ jobs:
                   # Ensure lock file is up to date
                   uv lock
 
+            - name: Update snapshot tests
+              run: |
+                  # Update snapshot tests to reflect the new version
+                  # The version appears in the splash screen SVG snapshots
+                  echo "Updating snapshot tests for version ${{ inputs.version }}..."
+                  uv run pytest tests/snapshots/ --snapshot-update -v
+
+                  # List the updated snapshot files
+                  echo "Updated snapshot files:"
+                  git status --short tests/snapshots/
+
             - name: Commit and push changes
               run: |
                   VERSION="${{ inputs.version }}"
                   BRANCH_NAME="${{ env.branch_name }}"
 
-                  # Stage all changes (pyproject.toml and uv.lock)
+                  # Stage all changes (pyproject.toml, uv.lock, and snapshot files)
                   git add pyproject.toml uv.lock
+                  git add tests/snapshots/
 
                   # Check if there are changes to commit
                   if git diff --cached --quiet; then
                     echo "❌ No changes detected. Version might already be set to $VERSION."
                     exit 1
                   fi
 
+                  # Count updated snapshot files and export for PR description
+                  SNAPSHOT_COUNT=$(git diff --cached --name-only -- 'tests/snapshots/' | wc -l)
+                  echo "snapshot_count=$SNAPSHOT_COUNT" >> $GITHUB_ENV
+
                   # Commit changes
                   git commit -m "Bump version to $VERSION" \
                              -m "- Updated version in pyproject.toml from ${{ env.current_version }} to $VERSION" \
-                             -m "- Regenerated uv.lock file"
+                             -m "- Regenerated uv.lock file" \
+                             -m "- Updated $SNAPSHOT_COUNT snapshot test file(s)"
 
                   # Push branch
                   git push origin "$BRANCH_NAME"
@@ -131,6 +152,7 @@ jobs:
               run: |
                   VERSION="${{ inputs.version }}"
                   BRANCH_NAME="${{ env.branch_name }}"
+                  SNAPSHOT_COUNT="${{ env.snapshot_count }}"
 
                   # Create draft PR using GitHub API
                   PR_RESPONSE=$(curl -s -X POST \
@@ -141,7 +163,7 @@ jobs:
                       "title": "Bump version to '"$VERSION"'",
                       "head": "'"$BRANCH_NAME"'",
                       "base": "main",
-                      "body": "## Summary\n\nThis PR bumps the project version to **'"$VERSION"'**.\n\n## Changes\n\n- Updated `version` in `pyproject.toml` from `'"${{ env.current_version }}"'` to `'"$VERSION"'`\n- Regenerated `uv.lock` file\n\n## Triggered by\n\nManual workflow dispatch by @'"${{ github.actor }}"'",
+                      "body": "## Summary\n\nThis PR bumps the project version to **'"$VERSION"'**.\n\n## Changes\n\n### pyproject.toml\n```diff\n-version = \"'"${{ env.current_version }}"'\"\n+version = \"'"$VERSION"'\"\n```\n\n### Other changes\n- Regenerated `uv.lock` file\n- Updated '"$SNAPSHOT_COUNT"' snapshot test file(s)\n\n## Triggered by\n\nManual workflow dispatch by @'"${{ github.actor }}"'",
                       "draft": true
                     }')