Fix README version replacement bug and improve mirror script robustness

[Copilot]

Problem

The original mirror.py script had a critical bug in the README version replacement logic that could cause incorrect version updates and potential workflow failures.

Critical Bug: Substring Replacement Issue

The original code used simple string replacement:

updated_readme = readme.replace(str(current_version), str(version))

This caused problems when version numbers were substrings of each other:

• Replacing 1.36.1 with 1.36.2 in README containing v1.36.10 would incorrectly produce v1.36.20
• The replacement was too broad and could affect unintended parts of the README

Additional Issues

1. No git tag conflict handling: Script would fail if tags already existed
2. Missing error handling: Git operations could fail silently
3. No progress logging: Difficult to debug workflow runs
4. Multi-version processing bug: README updates didn't carry forward correctly

Solution

1. Fixed README Version Replacement

Replaced naive string replacement with precise regex targeting:

updated_readme = re.sub(
    r'(\s+rev:\s+)v[0-9]+\.[0-9]+\.[0-9]+',
    rf'\1v{version}',
    readme
)

This ensures only the rev: v{version} line in YAML configuration is updated, preventing partial matches.

2. Added Git Tag Conflict Resolution

# Check if tag already exists before creating it
result = subprocess.run(["git", "tag", "-l", f"v{version}"], capture_output=True, text=True)
if not result.stdout.strip():
    subprocess.run(["git", "tag", f"v{version}"], check=True)
    print(f"Created tag v{version}")
else:
    print(f"Tag v{version} already exists, skipping")

3. Enhanced Error Handling and Logging

• Added check=True to all git operations for proper error detection
• Added informative progress messages for debugging
• Added early exit when no new versions are available

4. Fixed Multi-Version Processing

Ensured the readme variable is updated after each version so subsequent updates work correctly.

Testing

Created comprehensive validation that verifies:

• ✅ README version replacement handles edge cases correctly
• ✅ Git tag conflict resolution works
• ✅ Multi-version processing works sequentially
• ✅ PyPI API connectivity and version detection
• ✅ Complete workflow compliance with requirements
• ✅ All GitHub workflow triggers and permissions

Impact

This fix ensures the automated typos version mirroring workflow runs reliably:

• Prevents version corruption in README.md
• Avoids workflow failures from git tag conflicts
• Improves debugging with better logging
• Handles edge cases robustly

The workflow now correctly implements the requirements: mirror.yml periodically fetches new upstream PyPI versions, creates appropriate tags, and release.yml automatically publishes GitHub releases.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• astral.sh
  • Triggering command: curl -LsSf REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.