Update tag.py to support release candidate versions

Author: mwtrew

tag.py

@@ -13,13 +13,14 @@
 import sys
 import re
 
-SEMVER_REGEX = re.compile(fr'^v(?P<major>\d+?).(?P<minor>\d+?).(?P<patch>\d+?)$')
+SEMVER_REGEX = re.compile(fr'^v(?P<major>\d+?).(?P<minor>\d+?).(?P<patch>\d+?)(rc(?P<rc>\d+?))?$')
 react_api_env_var_name = 'REACT_APP_API_VERSION'
 REACT_API_ENV_REGEX = re.compile(fr'{react_api_env_var_name}=(?P<version>.*)')
 semver_options = {
     'major': 'Makes incompatible API changes',
     'minor': 'Adds (backwards-compatible) functionality',
     'patch': 'Makes (backwards-compatible) bug fixes',
+    'rc': 'Increments on an existing RC tag',
     'none': 'Don\'t update this service'
 }
 _default_subprocess_options = {'shell': True, 'check': True, 'capture_output': True, 'text': True}
@@ -29,27 +30,22 @@
     'api': dict({'cwd': api_working_directory}, **_default_subprocess_options),
 }
 
-def assert_using_a_tty():
-    if not sys.stdout.isatty():
-        print("Error: Must run this method with a tty. If you're using windows try:\n" + f"winpty {' '.join(sys.argv)}")
-        sys.exit(1)
-
 def parse_command_line_arguments():
     parser = argparse.ArgumentParser(description='Tag the code ready for a release.\n' +
-    	'; '.join(option.upper() + ': ' + description for option, description in semver_options.items()) + ".")
-    parser.add_argument('--app', choices=['major', 'minor', 'patch'], help='Set the semver update type for the App')
+                                                 '; '.join(option.upper() + ': ' + description for option, description in semver_options.items()) + ".")
+    parser.add_argument('--app', choices=['major', 'minor', 'patch', 'rc'], help='Set the semver update type for the App')
     parser.add_argument('--api', choices=semver_options.keys(), help='Set the semver update type for the API')
     return parser.parse_args()
 
 def ask_for_update_type_for(service_name):
     while True:
-        user_response = input(f'Are the changes to the {service_name}: [0] NONE, [1] PATCH, [2] MINOR, or [3] MAJOR?\n')
-        if len(user_response) != 1 and user_response not in ('0', '1', '2', '3'):
-            print("Please respond either '0', '1', '2' or '3'")
+        user_response = input(f'Are the changes to the {service_name}: [0] NONE, [R] RELEASE CANDIDATE (RC), [1] PATCH, [2] MINOR, or [3] MAJOR?\n')
+        if len(user_response) != 1 and user_response not in ('0', 'R', '1', '2', '3'):
+            print("Please respond either '0', 'R', '1', '2' or '3'")
         elif service_name == 'app' and user_response == '0':
             print("Our release procedure does not allow a new API to be released without an App update.")
         else:
-            return {'0': 'none', '1': 'patch', '2': 'minor', '3': 'major'}[user_response]
+            return {'0': 'none', 'R': 'rc', '1': 'patch', '2': 'minor', '3': 'major'}[user_response]
 
 def get_update_description_from_user(cli_input):
     # try to retrieve from command line args
@@ -61,9 +57,22 @@ def get_update_description_from_user(cli_input):
     return update_description
 
 def get_versions_from_github():
+    app_mainline = [x['name'] for x in requests.get('https://api.github.com/repos/isaacphysics/isaac-react-app/tags').json() if 'rc' not in x['name']][0]
+    api_mainline = [x['name'] for x in requests.get('https://api.github.com/repos/isaacphysics/isaac-api/tags').json() if 'rc' not in x['name']][0]
+    try:
+        app_rc = [x['name'] for x in requests.get('https://api.github.com/repos/isaacphysics/isaac-react-app/tags').json() if 'rc' in x['name']][0]
+    except IndexError:
+        app_rc = None
+    try:
+        api_rc = [x['name'] for x in requests.get('https://api.github.com/repos/isaacphysics/isaac-api/tags').json() if 'rc' in x['name']][0]
+    except IndexError:
+        api_rc = None
+
     return {
-        'app': requests.get('https://api.github.com/repos/isaacphysics/isaac-react-app/tags').json()[0]['name'],
-        'api': requests.get('https://api.github.com/repos/isaacphysics/isaac-api/tags').json()[0]['name'],
+        'app-mainline': app_mainline,
+        'api-mainline': api_mainline,
+        'app-rc': app_rc,
+        'api-rc': api_rc
     }
 
 def get_build_results_from_github(repo, branch):
@@ -85,18 +94,36 @@ def get_build_results_from_github(repo, branch):
 def increment_version(update_type):
     def repl_matcher(match):
         if update_type != 'none':
-            version = {'major': int(match.group('major')), 'minor': int(match.group('minor')), 'patch': int(match.group('patch'))}
-            version_order = ['major', 'minor', 'patch']
+            version = {'major': int(match.group('major')), 'minor': int(match.group('minor')), 'patch': int(match.group('patch')), 'rc': None if not match.group('rc') else int(match.group('rc'))}
+            version_order = ['major', 'minor', 'patch', 'rc']
             for ver in version_order:
                 if version_order.index(update_type) < version_order.index(ver):
                     version[ver] = 0
                 elif ver == update_type:
                     version[ver] += 1
-            return f"v{version['major']}.{version['minor']}.{version['patch']}"
+            if update_type == 'rc':
+                return f"v{version['major']}.{version['minor']}.{version['patch']}rc{version['rc']}"
+            else:
+                return f"v{version['major']}.{version['minor']}.{version['patch']}"
         else:
             return match.group(0)
     return repl_matcher
 
+def get_previous_versions_for_update_type(previous_versions, update_description):
+    prev = {}
+    for service_name in ['app', 'api']:
+        service_update_description = update_description[service_name]
+        if service_update_description == 'rc':
+            if previous_versions[f'{service_name}-rc']:
+                prev[service_name] = previous_versions[f"{service_name}-rc"]
+            else:
+                print("Error: RC update type requires an existing release candidate tag to increment on, and none was "
+                      "found. You may need to create an initial tag (e.g. vX.Y.Zrc0) by hand.")
+                sys.exit(1)
+        else:
+            prev[service_name] = previous_versions[f'{service_name}-mainline']
+    return prev
+
 def update_versions(previous_versions, update_description, snapshot=False):
     update_versions = {}
     for service_name in ['app', 'api']:
@@ -149,7 +176,7 @@ def set_versions(versions, update_description):
     # Record the App version
     # package.json
     subprocess.run(f"npm --no-git-tag-version version {versions['app']}", **subprocess_options['app'])
-    
+
     # Record the API version
     if update_description['api'] != 'none':
         # .env
@@ -182,21 +209,20 @@ def commit_and_push_changes(versions, update_description):
 
 
 if __name__ == '__main__':
-    assert_using_a_tty()
-
     cli_args = parse_command_line_arguments()
     update_description = get_update_description_from_user(cli_args)
 
     check_app_and_api_are_clean(update_description)
 
     most_recent_versions = get_versions_from_github()
-    target_versions = update_versions(most_recent_versions, update_description)
+    relevant_recent_versions = get_previous_versions_for_update_type(most_recent_versions, update_description)
+    target_versions = update_versions(relevant_recent_versions, update_description)
     check_user_is_ready_to_release(target_versions, update_description)
 
     set_versions(target_versions, update_description)
     commit_and_tag_changes(target_versions, update_description)
 
-    bump_update_description = {service: 'patch' if update != 'none' else 'none' for service, update in update_description.items()}
+    bump_update_description = {service: update if update in ['rc', 'none'] else 'patch' for service, update in update_description.items()}
     bumped_versions = update_versions(target_versions, bump_update_description, snapshot=True)
     set_versions(bumped_versions, update_description)
     commit_and_push_changes(target_versions, update_description)