|
| 1 | +Import('env') |
| 2 | +import subprocess |
| 3 | +import json |
| 4 | +import re |
| 5 | + |
| 6 | +def get_github_repo(): |
| 7 | + """Extract GitHub repository name from git remote URL. |
| 8 | + |
| 9 | + Uses the remote that the current branch tracks, falling back to 'origin'. |
| 10 | + This handles cases where repositories have multiple remotes or where the |
| 11 | + main remote is not named 'origin'. |
| 12 | + |
| 13 | + Returns: |
| 14 | + str: Repository name in 'owner/repo' format for GitHub repos, |
| 15 | + 'unknown' for non-GitHub repos, missing git CLI, or any errors. |
| 16 | + """ |
| 17 | + try: |
| 18 | + remote_name = 'origin' # Default fallback |
| 19 | + |
| 20 | + # Try to get the remote for the current branch |
| 21 | + try: |
| 22 | + # Get current branch name |
| 23 | + branch_result = subprocess.run(['git', 'rev-parse', '--abbrev-ref', 'HEAD'], |
| 24 | + capture_output=True, text=True, check=True) |
| 25 | + current_branch = branch_result.stdout.strip() |
| 26 | + |
| 27 | + # Get the remote for the current branch |
| 28 | + remote_result = subprocess.run(['git', 'config', f'branch.{current_branch}.remote'], |
| 29 | + capture_output=True, text=True, check=True) |
| 30 | + tracked_remote = remote_result.stdout.strip() |
| 31 | + |
| 32 | + # Use the tracked remote if we found one |
| 33 | + if tracked_remote: |
| 34 | + remote_name = tracked_remote |
| 35 | + except subprocess.CalledProcessError: |
| 36 | + # If branch config lookup fails, continue with 'origin' as fallback |
| 37 | + pass |
| 38 | + |
| 39 | + # Get the remote URL for the determined remote |
| 40 | + result = subprocess.run(['git', 'remote', 'get-url', remote_name], |
| 41 | + capture_output=True, text=True, check=True) |
| 42 | + remote_url = result.stdout.strip() |
| 43 | + |
| 44 | + # Check if it's a GitHub URL |
| 45 | + if 'github.com' not in remote_url.lower(): |
| 46 | + return None |
| 47 | + |
| 48 | + # Parse GitHub URL patterns: |
| 49 | + # https://github.com/owner/repo.git |
| 50 | + # [email protected]:owner/repo.git |
| 51 | + # https://github.com/owner/repo |
| 52 | + |
| 53 | + # Remove .git suffix if present |
| 54 | + if remote_url.endswith('.git'): |
| 55 | + remote_url = remote_url[:-4] |
| 56 | + |
| 57 | + # Handle HTTPS URLs |
| 58 | + https_match = re.search(r'github\.com/([^/]+/[^/]+)', remote_url, re.IGNORECASE) |
| 59 | + if https_match: |
| 60 | + return https_match.group(1) |
| 61 | + |
| 62 | + # Handle SSH URLs |
| 63 | + ssh_match = re.search(r'github\.com:([^/]+/[^/]+)', remote_url, re.IGNORECASE) |
| 64 | + if ssh_match: |
| 65 | + return ssh_match.group(1) |
| 66 | + |
| 67 | + return None |
| 68 | + |
| 69 | + except FileNotFoundError: |
| 70 | + # Git CLI is not installed or not in PATH |
| 71 | + return None |
| 72 | + except subprocess.CalledProcessError: |
| 73 | + # Git command failed (e.g., not a git repo, no remote, etc.) |
| 74 | + return None |
| 75 | + except Exception: |
| 76 | + # Any other unexpected error |
| 77 | + return None |
| 78 | + |
| 79 | +# WLED version is managed by package.json; this is picked up in several places |
| 80 | +# - It's integrated in to the UI code |
| 81 | +# - Here, for wled_metadata.cpp |
| 82 | +# - The output_bins script |
| 83 | +# We always take it from package.json to ensure consistency |
| 84 | +with open("package.json", "r") as package: |
| 85 | + WLED_VERSION = json.load(package)["version"] |
| 86 | + |
| 87 | +def has_def(cppdefs, name): |
| 88 | + """ Returns true if a given name is set in a CPPDEFINES collection """ |
| 89 | + for f in cppdefs: |
| 90 | + if isinstance(f, tuple): |
| 91 | + f = f[0] |
| 92 | + if f == name: |
| 93 | + return True |
| 94 | + return False |
| 95 | + |
| 96 | + |
| 97 | +def add_wled_metadata_flags(env, node): |
| 98 | + cdefs = env["CPPDEFINES"].copy() |
| 99 | + |
| 100 | + if not has_def(cdefs, "WLED_REPO"): |
| 101 | + repo = get_github_repo() |
| 102 | + if repo: |
| 103 | + cdefs.append(("WLED_REPO", f"\\\"{repo}\\\"")) |
| 104 | + |
| 105 | + cdefs.append(("WLED_VERSION", WLED_VERSION)) |
| 106 | + |
| 107 | + # This transforms the node in to a Builder; it cannot be modified again |
| 108 | + return env.Object( |
| 109 | + node, |
| 110 | + CPPDEFINES=cdefs |
| 111 | + ) |
| 112 | + |
| 113 | +env.AddBuildMiddleware( |
| 114 | + add_wled_metadata_flags, |
| 115 | + "*/wled_metadata.cpp" |
| 116 | +) |
0 commit comments