Fix update-examples workflow (#489)

Address issue faced by tag sorting in #487, #487. Make it possible to
specify both old and new version when running manually.

Author: gabrielfeo

.github/scripts/replace_string.py

@@ -50,8 +50,11 @@ def _badge_version(version: str) -> str:
     return version.replace('-', '--')
 
 
-def _should_replace_in(repo, file):
-    return file.is_file() and not repo.ignored(file) and file.parts[0] != '.git'
+def _should_replace_in(repo, file: Path) -> bool:
+    return file.is_file() \
+        and not repo.ignored(file) \
+        and file.parts[0] != '.git' \
+        and file.name != 'test_replace_string.py'
 
 
 if __name__ == "__main__":

.github/workflows/update-examples.yml

@@ -5,7 +5,10 @@ on:
     tags: [ '*' ]
   workflow_dispatch:
     inputs:
-      ref:
+      old:
+        description: 'Git ref of version to replace. Leave empty for auto-detect from git tags.'
+        required: false
+      new:
         description: 'Branch or tag'
         required: true
 
@@ -25,13 +28,14 @@ jobs:
       - run: pip install -r .github/scripts/requirements.txt
       - name: 'Get versions'
         run: |
-          new="${{ inputs.ref || github.ref_name }}"
-          echo "Deleting '$new' in case it's alpha to stable bump." \
-            "Git v:refname doesn't handle Maven version qualifiers correctly."
-          git tag -d "$new"
-          old="$(git tag --sort=-v:refname | head -n 1)"
-          echo "OLD_VERSION=$old" | tee -a $GITHUB_ENV
+          new="${{ inputs.new || github.ref_name }}"
           echo "NEW_VERSION=$new" | tee -a $GITHUB_ENV
+          if [[ "${{ inputs.old }}" == "" ]]; then
+            echo "Auto-detecting old version from git tags"
+            # Get previous version from descending tag list
+            old="$(git tag --sort=-v:refname | grep -A1 "$new" | tail -1)"
+          fi
+          echo "OLD_VERSION=$old" | tee -a $GITHUB_ENV
       - name: 'Update version in all files'
         run: ./.github/scripts/replace_string.py ./ "$OLD_VERSION" "$NEW_VERSION"
       - name: 'Create PR'
@@ -42,4 +46,4 @@ jobs:
           title: "Bump examples and badges to ${{ env.NEW_VERSION }}"
           author: "github-actions <github-actions@github.com>"
           committer: "github-actions <github-actions@github.com>"
-          body: "Bump the version in examples and badges from ${{ env.OLD_VERSION }} to ${{ env.NEW_VERSION }}."
+          body: "Bump versions from ${{ env.OLD_VERSION }} to ${{ env.NEW_VERSION }}."