Improve migration script results reporting (#507)

When the script succeeds, the message reporting the end of the script
now is more visible by adding colors and emojis, and more clear about
the script finishing **successfully**.

When the script reports manual steps, the message reporting the end of
the script now mentions manual steps are needed more visibly (adding
colors and blinking emojis), and report the list of manual steps the
user needs to perform. In this case the script will report the number of
manual steps as exit status too, so the script fails if there are manual
steps.

Author: llucax

.github/cookiecutter-migrate.template.py

@@ -24,17 +24,38 @@
 import json
 import os
 import subprocess
+import sys
 import tempfile
 from pathlib import Path
 from typing import SupportsIndex
 
+_manual_steps: list[str] = []  # pylint: disable=invalid-name
+
 
 def main() -> None:
     """Run the migration steps."""
     # Add a separation line like this one after each migration step.
     print("=" * 72)
-    print("Migration script finished. Remember to follow any manual instructions.")
-    print("=" * 72)
+    print()
+
+    if _manual_steps:
+        print(
+            "\033[5;33m⚠️⚠️⚠️\033[0;33m Remember to check the manual steps: \033[5;33m⚠️⚠️⚠️\033[0m"
+        )
+        for n, step in enumerate(_manual_steps, start=1):
+            print(f"\033[5;33m⚠️⚠️⚠️   \033[0;33m{n}. {step}\033[0m")
+        print()
+
+        print(
+            "\033[5;31m❌\033[0;31m Migration script finished but requires manual "
+            "intervention \033[5;31m❌\033[0m"
+        )
+        print()
+
+        sys.exit(len(_manual_steps))
+
+    print("\033[0;32m       ✅ Migration script finished successfully ✅\033[0m")
+    print()
 
 
 def read_project_type() -> str | None:
@@ -146,6 +167,7 @@ def calculate_file_sha256_skip_lines(filepath: Path, skip_lines: int) -> str | N
 
 def manual_step(message: str) -> None:
     """Print a manual step message in yellow."""
+    _manual_steps.append(message)
     print(f"\033[0;33m>>> {message}\033[0m")
 
 

cookiecutter/migrate.py

@@ -25,10 +25,13 @@
 import os
 import re
 import subprocess
+import sys
 import tempfile
 from pathlib import Path
 from typing import SupportsIndex
 
+_manual_steps: list[str] = []  # pylint: disable=invalid-name
+
 
 def main() -> None:
     """Run the migration steps."""
@@ -40,8 +43,26 @@ def main() -> None:
     print("Migrating pyproject license metadata to SPDX format...")
     migrate_pyproject_license()
     print("=" * 72)
-    print("Migration script finished. Remember to follow any manual instructions.")
-    print("=" * 72)
+    print()
+
+    if _manual_steps:
+        print(
+            "\033[5;33m⚠️⚠️⚠️\033[0;33m Remember to check the manual steps: \033[5;33m⚠️⚠️⚠️\033[0m"
+        )
+        for n, step in enumerate(_manual_steps, start=1):
+            print(f"\033[5;33m⚠️⚠️⚠️   \033[0;33m{n}. {step}\033[0m")
+        print()
+
+        print(
+            "\033[5;31m❌\033[0;31m Migration script finished but requires manual "
+            "intervention \033[5;31m❌\033[0m"
+        )
+        print()
+
+        sys.exit(len(_manual_steps))
+
+    print("\033[0;32m       ✅ Migration script finished successfully ✅\033[0m")
+    print()
 
 
 def migrate_to_ubuntu_slim() -> None:
@@ -427,6 +448,7 @@ def calculate_file_sha256_skip_lines(filepath: Path, skip_lines: int) -> str | N
 
 def manual_step(message: str) -> None:
     """Print a manual step message in yellow."""
+    _manual_steps.append(message)
     print(f"\033[0;33m>>> {message}\033[0m")