Skip to content

Improve migration script results reporting #507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
llucax merged 1 commit into from
Feb 13, 2026
Merged

Improve migration script results reporting #507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions .github/cookiecutter-migrate.template.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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")


Expand Down
26 changes: 24 additions & 2 deletions cookiecutter/migrate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."""
Expand All @@ -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:
Expand Down Expand Up @@ -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")


Expand Down