Update translations Scripts

Author: marionbarker

Scripts/LocalizationInstructions.md

@@ -9,27 +9,27 @@ set -u
 source Scripts/define_common.sh
 
 # use a common message with the time at which xliff files were downloaded from lokalise
-if [[ -e "${message_file}" ]]; then
-    message_string=$(<"${message_file}")
+if [[ -e "${MESSAGE_FILE}" ]]; then
+    message_string=$(<"${MESSAGE_FILE}")
 else
     message_string="message not defined"
 fi
 echo "message_string = ${message_string}"
 
-for project in ${projects}; do
-  echo "Archive ${translation_branch} branch for $project"
+for project in ${PROJECTS}; do
+  echo "Archive ${TRANSLATION_BRANCH} branch for $project"
   IFS=":" read user dir branch <<< "$project"
   echo "parts = $user $dir $branch"
   cd $dir
-  if git switch ${translation_branch}; then
-    echo "in $dir, configure $archive_branch"
-    git branch -D ${archive_branch} || true
-    git switch -c ${archive_branch}
+  if git switch ${TRANSLATION_BRANCH}; then
+    echo "in $dir, configure $ARCHIVE_BRANCH"
+    git branch -D ${ARCHIVE_BRANCH} || true
+    git switch -c ${ARCHIVE_BRANCH}
     git add .
     if git commit -m "${message_string}"; then
-        echo "updated $dir with ${message_string} in ${archive_branch} branch"    
+        echo "updated $dir with ${message_string} in ${ARCHIVE_BRANCH} branch"    
     fi
-    git branch -D ${translation_branch}
+    git branch -D ${TRANSLATION_BRANCH}
   fi
   cd -
 done
@@ -38,4 +38,3 @@ git submodule update
 git status
 
 echo "You may need to manually clean branches not in the project list"
-

Scripts/archive_translations.sh

@@ -1,23 +1,34 @@
 #!/bin/zsh
 
-# define variables used by more than one script
-#   variables are:
-#      message_file
-#      archive_branch
-#      translation_branch
-#      projects
+# define parameters and arrays used by more than one script
+#   These are always capitalized
+#   First two can be replaced with arguments
+#      TRANSLATION_BRANCH (arg 1)
+#      TARGET_LOOPWORKSPACE_BRANCH (arg 2)
+#      MESSAGE_FILE
+#      ARCHIVE_BRANCH
+#      PROJECTS
 #      LANGUAGES
 
 # include this file in each script using
 #   source Scripts/define_commont.sh
 
-# define name of file used to save the commit message and title for pull requests
-message_file="xlate_message_file.txt"
-
 # define the branch names used by the translation scripts
-archive_branch="archive_translations"
-translation_branch="translations"
-target_loopworkspace_branch="dev"
+# Any script that uses define_common can be called with one or two optional arguments
+#   first argument replaces default for TRANSLATION_BRANCH
+#   second argument replaces default for TARGET_LOOPWORKSPACE_BRANCH
+# Note: went for simplicity here - if you want to modify TARGET_LOOPWORKSPACE_BRANCH
+#   via argument, you must also include TRANSLATION_BRANCH as an argument
+DEFAULT_TRANSLATION_BRANCH="translations"
+DEFAULT_TARGET_LOOPWORKSPACE_BRANCH="dev"
+
+TRANSLATION_BRANCH=${1:-$DEFAULT_TRANSLATION_BRANCH}
+TARGET_LOOPWORKSPACE_BRANCH=${2:-$DEFAULT_TARGET_LOOPWORKSPACE_BRANCH}
+
+ARCHIVE_BRANCH="archive_translations"
+
+# define name of file used to save the commit message and title for pull requests
+MESSAGE_FILE="xlate_message_file.txt"
 
 # define the languages used by the translation scripts
 # matches lokalise order, en plus alphabetical order by language name in English
@@ -46,8 +57,8 @@ LANGUAGES=(en \
     vi \
 )
 
-# define the projects used by the translation scripts
-projects=( \
+# define the PROJECTS used by the translation scripts
+PROJECTS=( \
     LoopKit:AmplitudeService:dev \
     LoopKit:CGMBLEKit:dev \
     LoopKit:dexcom-share-client-swift:dev \
@@ -73,3 +84,26 @@ function section_divider() {
     echo -e "--------------------------------"
     echo -e ""
 }
+
+function continue_or_quit() {
+    local script_name=$1
+    section_divider
+    echo "Enter y to proceed, any other character exits"
+    read query
+
+    if [[ ${query} != "y" ]]; then
+        section_divider
+        echo "User opted to exit ${script_name}."
+        section_divider
+        exit 1
+    fi
+}
+
+function next_script() {
+    local next_script_name=$1
+    if [[ ${TRANSLATION_BRANCH} == ${DEFAULT_TRANSLATION_BRANCH} ]]; then
+        echo "$next_script_name"
+    else
+        echo "$next_script_name ${TRANSLATION_BRANCH}"
+    fi
+}

Scripts/define_common.sh

@@ -27,9 +27,9 @@ lokalise2 \
     --replace-breaks=false \
     --unzip-to ./xliff_in
 
-projects=(LoopKit:AmplitudeService:dev LoopKit:CGMBLEKit:dev LoopKit:G7SensorKit:main LoopKit:LogglyService:dev LoopKit:Loop:dev LoopKit:LoopKit:dev LoopKit:LoopOnboarding:dev LoopKit:LoopSupport:dev LoopKit:NightscoutRemoteCGM:dev LoopKit:NightscoutService:dev LoopKit:OmniBLE:dev LoopKit:TidepoolService:dev LoopKit:dexcom-share-client-swift:dev LoopKit:RileyLinkKit:dev LoopKit:OmniKit:main LoopKit:MinimedKit:main LoopKit:LibreTransmitter:main)
+PROJECTS=(LoopKit:AmplitudeService:dev LoopKit:CGMBLEKit:dev LoopKit:G7SensorKit:main LoopKit:LogglyService:dev LoopKit:Loop:dev LoopKit:LoopKit:dev LoopKit:LoopOnboarding:dev LoopKit:LoopSupport:dev LoopKit:NightscoutRemoteCGM:dev LoopKit:NightscoutService:dev LoopKit:OmniBLE:dev LoopKit:TidepoolService:dev LoopKit:dexcom-share-client-swift:dev LoopKit:RileyLinkKit:dev LoopKit:OmniKit:main LoopKit:MinimedKit:main LoopKit:LibreTransmitter:main)
 
-for project in ${projects}; do
+for project in ${PROJECTS}; do
   echo "Prepping $project"
   IFS=":" read user dir branch <<< "$project"
   echo "parts = $user $dir $branch"
@@ -52,7 +52,7 @@ end
 
 
 # Generate branches, commit and push.
-for project in ${projects}; do
+for project in ${PROJECTS}; do
   echo "Commiting $project"
   IFS=":" read user dir branch <<< "$project"
   echo "parts = $user $dir $branch"
@@ -68,7 +68,7 @@ for project in ${projects}; do
 done
 
 # Reset 
-#for project in ${projects}; do
+#for project in ${PROJECTS}; do
 #  echo "Commiting $project"
 #  IFS=":" read user dir branch <<< "$project"
 #  echo "parts = $user $dir $branch"

Scripts/import_localizations.sh

@@ -3,81 +3,62 @@
 set -e
 set -u
 
-# this script prepares a branch of LoopWorkspace based on current local branch.
-# It brings in the tip of all the submodule branches which should have just
-# been updated with the manual download, import, review and finalize scripts.
-# After all those PR are merged and the translation branches trimmed,
-# the next step is to prepare the PR to update LoopWorkspace dev branch
+# this script prepares a PR for LoopWorkspace based on current local branch
 
 source Scripts/define_common.sh
 
 section_divider
-
-echo "You must be in the LoopWorkspace folder ready to bring in "
-echo "  all the latest versions of the submodules which were "
-echo "  just translated"
-echo ""
-echo "This script will prepare a PR to LoopWorkspace '${target_loopworkspace_branch}' branch"
-echo ""
-echo "1. If the branch name is not already '${translation_branch}', then"
+echo "You are running ${0}"
+echo "  You must be in the LoopWorkspace folder ready to commit changes to"
+echo "  tracked files in this clone, see 'git status' results below:"
+section_divider
+git status
+section_divider
+echo "This script will prepare a PR to LoopWorkspace '${TARGET_LOOPWORKSPACE_BRANCH}' branch"
+echo 
+echo "1. If the local clone LoopWorkspace branch name is not already '${TRANSLATION_BRANCH}', then"
 echo "   that branch will be created and used for this PR"
-echo "2. ./Scripts/update_submodule_refs.sh will be executed"
-echo "3. The commit message in the ${message_file} will be used"
-cat ${message_file}
-echo "4. Once the PR is prepared, additional commits can be added as needed"
+echo "2. The commit message in the ${MESSAGE_FILE} will be used"
+cat ${MESSAGE_FILE}
+echo "3. Once the PR is prepared, additional commits can be added as needed"
 
-section_divider
+continue_or_quit ${0}
 
-echo "Enter y to proceed, any other character exits"
-read query
+current_branch=$(git branch --show-current 2>/dev/null)
+echo "current_branch = $current_branch"
 
-if [[ ${query} == "y" ]]; then
+if [[ "${current_branch}" == "${TRANSLATION_BRANCH}" ]]; then
+        echo "already on $TRANSLATION_BRANCH, ok to continue"
 
-    current_branch=$(git branch --show-current 2>/dev/null)
-    echo "current_branch = $current_branch"
+elif [ -n "$(git branch --list "$TRANSLATION_BRANCH")" ]; then
+    echo "Local branch '$TRANSLATION_BRANCH' exists."
+        echo "You are on '$current_branch' and '$TRANSLATION_BRANCH' already exists"
+        echo "quitting"
+        exit 1 # exit with failure
 
-    if [[ "${current_branch}" == "${translation_branch}" ]]; then
-            echo "already on $translation_branch, ok to continue"
-    
-    elif [ -n "$(git branch --list "$translation_branch")" ]; then
-        echo "Local branch '$translation_branch' exists."
-            echo "You are on '$current_branch' and '$translation_branch' already exists"
-            echo "quitting"
-            exit 1 # exit with failure
-    
-    else
-        echo "Local branch $translation_branch does not exist,"
-        echo "creating $translation_branch from the current branch, $current_branch."
-        git switch -c "${translation_branch}"
-    fi
+else
+    echo "Local branch $TRANSLATION_BRANCH does not exist,"
+    echo "creating $TRANSLATION_BRANCH from the current branch, $current_branch."
+    git switch -c "${TRANSLATION_BRANCH}"
+fi
 
-    section_divider
+continue_or_quit ${0}
 
-    ./Scripts/update_submodule_refs.sh
+# only create a PR if there are changes
+if git commit -a -F "${MESSAGE_FILE}"; then
+    git push --set-upstream origin ${TRANSLATION_BRANCH}
+    pr=$(gh pr create -B ${TARGET_LOOPWORKSPACE_BRANCH} --fill 2>&1 | grep http)
+    echo "PR = $pr"
+    open $pr
 
     section_divider
-
-    # only create a PR if there are changes
-    if git commit -a -F "${message_file}"; then
-        git push --set-upstream origin ${translation_branch}
-        pr=$(gh pr create -B ${target_loopworkspace_branch} --fill 2>&1 | grep http)
-        echo "PR = $pr"
-        open $pr
-
-        section_divider
-        echo "After you review, ${pr}, get approvals and merge the PR"
-        echo " be sure to trim the '${translation_branch}' branch,"
-        echo " and then run the export and upload scripts again from the updated '${target_loopworkspace_branch}' branch"
-        section_divider
-
-    else
-        section_divider
-        echo "No changes were found, no PR created"
-        section_divider
-    fi
+    echo "After you review, ${pr}, get approvals and merge the PR"
+    echo " be sure to trim the '${TRANSLATION_BRANCH}' branch,"
+    echo " and then run the export and upload scripts again from the updated '${TARGET_LOOPWORKSPACE_BRANCH}' branch"
+    section_divider
 
 else
     section_divider
-    echo "user opted to exit the script"
+    echo "No changes were found, no PR created"
     section_divider
 fi

Scripts/manual_LoopWorkspace_prepare_pr.sh

@@ -9,25 +9,36 @@
 set -e
 set -u
 
+source Scripts/define_common.sh
+
+section_divider
+echo "You are running ${0}"
+echo "  Be sure you are completely done with the translation process"
+echo "  or that you want to discard all your work to date"
+echo
 echo " /////////// WARNING ///////////"
-echo "Be sure you are completely done with the translations process or"
-echo " that you want to discard all your work to date"
+echo
 echo " This deletes the xclocs, xliff_in, xliff_out folders"
-echo " This deletes the standard title for the PRs for submodules and LoopWorkspace"
-echo ""
-echo "Enter y return to continue, any other key to quit"
-read query
-echo ""
+echo " This deletes the file, ${MESSAGE_FILE}, with the lokalise download timestamp"
+echo " This restores all submodules to their current branch (reset, clean)"
+
+continue_or_quit ${0}
 
-if [[ ${query} == "y" ]]; then
+rm -rf xclocs
+rm -rf xliff_in
+rm -rf xliff_out
+rm -f "${MESSAGE_FILE}"
 
-    rm -rf xclocs
-    rm -rf xliff_in
-    rm -rf xliff_out
-    rm "${message_file}"
-    echo "Temporary folders and ${message_file} removed from LoopWorkspace"
+for project in ${PROJECTS}; do
+  IFS=":" read user dir branch <<< "$project"
+  echo "Reset and clean $dir"
+  cd $dir
+  git reset --hard; git clean -fd;
+  cd -
+done
 
-else
-    echo "Exited without deleting folders and files"
 
-fi
+section_divider
+echo "Temporary folders and ${MESSAGE_FILE} removed from LoopWorkspace"
+echo "All folders in PROJECTS reset and cleaned"
+section_divider

Scripts/manual_cleanup.sh

@@ -19,12 +19,17 @@ date=`date`
 
 source Scripts/define_common.sh
 
+section_divider
+echo "You are running ${0}"
+echo "  This requests localization files from lokalise"
+
 # Fetch translations from lokalise
 rm -rf xliff_in
 lokalise2 \
     --token "$LOKALISE_TOKEN" \
     --project-id "414338966417c70d7055e2.75119857" \
     file download \
+    --async\
     --format xliff \
     --bundle-structure "%LANG_ISO%.%FORMAT%" \
     --original-filenames=false \
@@ -33,14 +38,17 @@ lokalise2 \
     --replace-breaks=false \
     --unzip-to ./xliff_in
 
-# create the temporary file xlate_pr_title.txt using the date of the import from localize
-# this overwrites any existing file because we want to capture the date of the actual download
-
-echo "Updated translations from lokalise on ${date}" > "${message_file}"
+# create xlate_pr_title.txt using the date of the import from localize
+# this overwrites any existing file because we want to capture the date of the latest download
 
-echo "The standard translation commit message is stored in ${message_file}"
+section_divider
+echo "Updated translations from lokalise on ${date}" > "${MESSAGE_FILE}"
+echo "The standard translation commit message is stored in ${MESSAGE_FILE}"
 
-echo ""
-echo "Continue by reviewing the importing the files in xliff_in"
-echo " for each submodule with command:"
-echo "./Scripts/manual_import_localizations.sh"
+section_divider
+echo "To import from the xliff_in folder for each submodule, execute"
+echo "./Scripts/manual_import_localizations.sh"
+echo
+echo "If you prefer to use a path other than '${DEFAULT_TRANSLATION_BRANCH}',"
+echo " add that as the first argument on the import script"
+section_divider