Update Package.swift tag when manually triggering release.

Author: arik-so

.github/workflows/release-framework.yml

@@ -27,6 +27,10 @@ jobs:
                     xcode-version: latest
             -   name: Checkout
                 uses: actions/checkout@v2
+            -   name: Update Package.swift tag to ${{ github.event.inputs.tag }}
+                if: ${{ github.event.inputs.tag != null && github.event.inputs.tag != '' }}
+                run: |
+                    python3 ./src/scripts/update_swift_package_checksum.py --tag ${{ github.event.inputs.tag }}
             -   name: Install Dependencies
                 uses: ./.github/actions/install-dependencies
                 with:
@@ -38,7 +42,8 @@ jobs:
             -   name: Update Package.swift checksum
                 if: ${{ github.event.inputs.tag != null && github.event.inputs.tag != '' }}
                 run: |
-                    python3 ./src/scripts/update_swift_package_checksum.py `swift package compute-checksum LightningDevKit.xcframework.zip`
+                    CHECKSUM=`swift package compute-checksum LightningDevKit.xcframework.zip`
+                    python3 ./src/scripts/update_swift_package_checksum.py --checksum "${CHECKSUM}"
                     git commit -m "Update Package.swift for ${{ github.event.inputs.tag }} release." ./Package.swift
                     git tag ${{ github.event.inputs.tag }}
                     git push origin HEAD:main --tags

src/scripts/update_swift_package_checksum.py

@@ -1,42 +1,81 @@
+import argparse
 import json
 import os
 import re
 import sys
 
 
-def run(new_checksum: str):
-	print("setting checksum (JSON-serialization):")
-	print(json.dumps(new_checksum))
-
-	if not new_checksum.isalnum():
-		print('Checksum must be alphanumeric.', file=sys.stderr)
+def run(new_checksum: str = None, new_tag: str = None):
+	if new_checksum is None and new_tag is None:
+		print('At least one of --checksum or --tag arguments must be provided.', file=sys.stderr)
 		sys.exit(1)
 
-	if not new_checksum.islower():
-		print('Checksum must be lowercase.', file=sys.stderr)
-		sys.exit(1)
+	if new_checksum is not None:
+		if not new_checksum.isalnum():
+			print('Checksum must be alphanumeric.', file=sys.stderr)
+			sys.exit(1)
+
+		if not new_checksum.islower():
+			print('Checksum must be lowercase.', file=sys.stderr)
+			sys.exit(1)
+
+		try:
+			int(new_checksum, 16)
+		except:
+			print('Checksum must be hexadecimal.', file=sys.stderr)
+			sys.exit(1)
+
+	if new_tag is not None:
+		if new_tag.strip() != new_tag:
+			print('Tag must not contain any whitespace.', file=sys.stderr)
+
+		tag_regex = re.compile("^\d+[.]\d+[.]\d+$")
+		tag_match = tag_regex.match(new_tag)
+		if tag_match is None:
+			print('Tag must adhere to x.x.x major/minor/patch format.', file=sys.stderr)
+
+	settings = [
+		{'variable_name': 'checksum', 'value': new_checksum},
+		{'variable_name': 'tag', 'value': new_tag},
+	]
+
+	package_file_path = os.path.realpath(os.path.join(os.path.dirname(__file__), '../../Package.swift'))
+	print(package_file_path)
+
+
 
+	original_package_file = None
 	try:
-		int(new_checksum, 16)
+		with open(package_file_path, 'r') as package_file_handle:
+			original_package_file = package_file_handle.read()
 	except:
-		print('Checksum must be hexadecimal.', file=sys.stderr)
+		print('Failed to read Package.swift file.', file=sys.stderr)
 		sys.exit(1)
 
+	package_file = original_package_file
+	for current_setting in settings:
+		current_variable_name = current_setting['variable_name']
+		new_value = current_setting['value']
+		if new_value is None:
+			continue
 
-	package_file_path = os.path.realpath(os.path.join(os.path.dirname(__file__), '../../Package.swift'))
-	print(package_file_path)
-	regex = re.compile("(let[\s]+checksum[\s]*=[\s]*)(.*)")
+		print(f'setting {current_variable_name} (JSON-serialization):')
+		print(json.dumps(new_value))
+
+		regex = re.compile(f'(let[\s]+{current_variable_name}[\s]*=[\s]*)(.*)')
+
+		previous_value = regex.search(package_file).group(2)
+		# new_package_file = checksum_regex.sub(f'\g<1>"{new_checksum}"', package_file)
+		package_file = package_file.replace(previous_value, f'"{new_value}"')
 
-	with open(package_file_path, 'r') as package_file_handle:
-		package_file = package_file_handle.read()
-		previous_checksum = regex.search(package_file).group(2)
-		# new_package_file = regex.sub(f'\g<1>"{new_checksum}"', package_file)
-		new_package_file = package_file.replace(previous_checksum, f'"{new_checksum}"')
-		with open(package_file_path, "w") as f:
-			f.write(new_package_file)
+	with open(package_file_path, "w") as f:
+		f.write(package_file)
 
 
 
 if __name__ == '__main__':
-	new_checksum = sys.argv[1]
-	run(new_checksum)
+	parser = argparse.ArgumentParser(description='Process some integers.')
+	parser.add_argument('--checksum', type=str, help='new checksum of LightningDevKit.xcframework.zip', required=False, default=None)
+	parser.add_argument('--tag', type=str, help='new release tag', required=False, default=None)
+	args = parser.parse_args()
+	run(new_checksum=args.checksum, new_tag=args.tag)