Merge pull request #30 from google/update-script

feat: Add update script

Author: another-rex

update-script.py

@@ -0,0 +1,117 @@
+#!/usr/bin/env python3
+
+"""
+Performs the three git commit required to do a release. See help output for more details.
+"""
+
+import subprocess
+import re
+import sys
+
+
+def cmd(command: list[str]) -> str:
+    print('$ ' + ' '.join(command))
+    process = subprocess.run(command, capture_output=True, text=True)
+    if process.returncode != 0:
+        print('failed to run above command, got exit code: %d', process.returncode)
+        print('stderr: ' + process.stderr.strip())
+        exit(process.returncode)
+
+    output = process.stdout.strip()
+    print('# ' + output)
+    return output
+
+
+def find_and_replace_regex_in_file(file_path: str, find_regex: str,
+                                   replace: str):
+
+    print(f'Performing find and replace on "{file_path}": s/{find_regex}/{replace}')
+    # Read in the file
+    with open(file_path, 'r') as file:
+        filedata = file.read()
+
+    filedata = re.sub(find_regex, replace, filedata)
+
+    # Write the file out again
+    with open(file_path, 'w') as file:
+        file.write(filedata)
+
+
+def print_help():
+    print('''update-script.py <target-tag>
+
+Performs a series of git merges to update all references of the previous version to the specified tag of osv-scanner. This script expects upstream remote to be named `upstream`
+1. Fetch upstream main branch
+2. Create new branch on the most recent version tag (the last release commit)
+3. Update references to the old osv-scanner tag to the new tag, and make the first commit
+4. Update references to the old .github/workflows/osv-scanner-reusable.yml version to the newly made commit in the last step. Make the second commit.
+5. Finally update the unified workflow to point to the commit made in step 4, perform the third commit.
+
+After this script is complete, push the new branch and create a PR. This PR must be merged via a normal git merge commit, NOT a squash commit.
+Then create the new release tag on this merged PR commit.''')
+
+
+if len(sys.argv) != 2:
+    print_help()
+    exit()
+
+target_tag = sys.argv[1]
+if not target_tag.startswith('v'):
+    print_help()
+    print('Target tag needs to begin with v')
+    exit()
+
+cmd(['git', 'fetch', 'upstream'])
+print("fetched and checkout upstream/main")
+
+lastest_tag = cmd(['git', 'describe', '--tags', '--abbrev=0'])
+branch_name = cmd(['git', 'branch', '--show-current'])
+
+cmd(['git', 'checkout', '-b', 'update-to-' + target_tag, 'upstream/main'])
+
+find_and_replace_regex_in_file('osv-reporter-action/action.yml',
+                               re.escape(lastest_tag), target_tag)
+find_and_replace_regex_in_file('osv-scanner-action/action.yml',
+                               re.escape(lastest_tag), target_tag)
+find_and_replace_regex_in_file('README.md', re.escape(lastest_tag), target_tag)
+
+cmd([
+    'git', 'commit', '-a', '-m',
+    f'Update actions to use {target_tag} osv-scanner image'
+])
+
+first_commit_hash = cmd(['git', 'rev-parse', 'HEAD'])
+print('First commit hash: ' + first_commit_hash)
+
+find_and_replace_regex_in_file(
+    '.github/workflows/osv-scanner-reusable.yml',
+    'uses: google/osv-scanner-action/osv-(.*?)-action@.*? # .*',
+    f'uses: google/osv-scanner-action/osv-\\1-action@{first_commit_hash} # {target_tag}'
+)
+
+find_and_replace_regex_in_file(
+    '.github/workflows/osv-scanner-reusable-pr.yml',
+    'uses: google/osv-scanner-action/osv-(.*?)-action@.*? # .*',
+    f'uses: google/osv-scanner-action/osv-\\1-action@{first_commit_hash} # {target_tag}'
+)
+
+cmd([
+    'git', 'commit', '-a', '-m',
+    f'Update reusable workflows to point to {target_tag} actions'
+])
+
+second_commit_hash = cmd(['git', 'rev-parse', 'HEAD'])
+print('Second commit hash: ' + second_commit_hash)
+
+find_and_replace_regex_in_file(
+    '.github/workflows/osv-scanner-unified-workflow.yml',
+    'uses: "google/osv-scanner-action/\\.github/workflows/osv-scanner-reusable(.*?)@.*?" # .*',
+    f'uses: "google/osv-scanner-action/.github/workflows/osv-scanner-reusable\\1@{second_commit_hash}" # {target_tag}'
+)
+
+cmd([
+    'git', 'commit', '-a', '-m',
+    f'Update unified workflow example to point to {target_tag} reusable workflows'
+])
+
+print('Success!')