github2gerrit 1.1.0__tar.gz → 1.2.1__tar.gz

{github2gerrit-1.1.0 → github2gerrit-1.2.1}/.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 # SPDX-FileCopyrightText: 2025 The Linux Foundation
 
 ci:
-  skip: [pytest]
+  skip: [pytest, gha-workflow-linter]
   autofix_commit_msg: |
     Chore: pre-commit autofixes
 
@@ -59,7 +59,7 @@ repos:
         types: [yaml]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: b969e2851312ca2b24bbec879ba4954341d1bd12  # frozen: v0.15.5
+    rev: b831c3dc5d27d9da294ae4e915773b99aa24a7c5  # frozen: v0.15.10
     hooks:
       - id: ruff
         files: ^(src|scripts|tests)/.+\.py$
@@ -68,7 +68,7 @@ repos:
         files: ^(src|scripts|tests)/.+\.py$
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: a66e98df7b4aeeb3724184b332785976d062b92e  # frozen: v1.19.1
+    rev: 0f369d245750787ce34997d464ed9605391a5283  # frozen: v1.20.1
     hooks:
       - id: mypy
         files: ^src/.+\.py$
@@ -76,13 +76,6 @@ repos:
           - types-PyYAML
           - types-requests
 
-  # Doesn't seem to run reliably inside pre-commit.ci
-  # - repo: https://github.com/RobertCraigie/pyright-python
-  #   rev: d393df1703a808473b84bd14a2702f4793014031  # frozen: v1.1.404
-  #   hooks:
-  #     - id: pyright
-  #       files: ^(src|scripts|tests)/.+\.py$
-
   - repo: https://github.com/btford/write-good
     rev: ab66ce10136dfad5146e69e70f82a3efac8842c1 # frozen: v1.0.8
     hooks:
@@ -110,7 +103,7 @@ repos:
   # Replaces: https://github.com/rhysd/actionlint
   # Permits actionlint to run both locally and with precommit.ci/GitHub
   - repo: https://github.com/Mateusz-Grzelinski/actionlint-py
-    rev: 694e2c0dfb4253d51f3c6c54b8f9fec0a16764dc  # frozen: v1.7.11.24
+    rev: c04ed26e40637cab1aa9879c693832a9c120fb20  # frozen: v1.7.12.24
     hooks:
       - id: actionlint
 
@@ -120,8 +113,20 @@ repos:
     hooks:
       - id: codespell
 
+  # Requires a mirror, primary repo lacks .pre-commit-hooks.yaml
+  - repo: https://github.com/DetachHead/basedpyright-prek-mirror
+    rev: 7664ed7e31234c8369d85ee9a13a1ca3361c0aa1  # frozen: 1.39.0
+    hooks:
+      - id: basedpyright
+        files: ^src/.+\.py$
+
+  - repo: https://github.com/lfreleng-actions/gha-workflow-linter
+    rev: a7caf8f3a1a05688d1cee46615ff94def617e5a3  # frozen: v1.0.2
+    hooks:
+      - id: gha-workflow-linter
+
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 8db279a37c552206d2df62269ff6f9d31125815a  # frozen: 0.37.0
+    rev: ed81924a8b1cecdaa570b072528fa80c9c4d6ccd  # frozen: 0.37.1
     hooks:
       - id: check-github-actions
       - id: check-github-workflows

{github2gerrit-1.1.0 → github2gerrit-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: github2gerrit
-Version: 1.1.0
+Version: 1.2.1
 Summary: Submit a GitHub pull request to a Gerrit repository.
 Project-URL: Homepage, https://github.com/lfreleng-actions/github2gerrit-action
 Project-URL: Repository, https://github.com/lfreleng-actions/github2gerrit-action

{github2gerrit-1.1.0 → github2gerrit-1.2.1}/action.yaml

@@ -157,6 +157,10 @@ inputs:
     description: "Create a Gerrit change when an UPDATE operation cannot find an existing one"
     required: false
     default: "false"
+  G2G_DISABLED:
+    description: "Set to 'true' to disable the action entirely (exits successfully with a message)"
+    required: false
+    default: ""
 
 outputs:
   gerrit_change_request_url:
@@ -172,7 +176,34 @@ outputs:
 runs:
   using: "composite"
   steps:
+    - name: "Check if GitHub2Gerrit is disabled"
+      id: disabled-check
+      shell: bash
+      run: |
+        # Check if GitHub2Gerrit is disabled
+        set -euo pipefail
+        DISABLED_ENV="${G2G_DISABLED:-}"
+        DISABLED_INPUT="${{ inputs.G2G_DISABLED }}"
+        # Normalize: accept the same truthy set as env_bool()
+        # (1/true/yes/on, case-insensitive, trimmed)
+        _normalize() {
+          printf '%s' "$1" | tr '[:upper:]' '[:lower:]' | xargs
+        }
+        _is_truthy() {
+          case "$(_normalize "$1")" in
+            1|true|yes|on) return 0 ;;
+            *) return 1 ;;
+          esac
+        }
+        if _is_truthy "${DISABLED_ENV}" || _is_truthy "${DISABLED_INPUT}"; then
+          echo "🛑 GitHub2Gerrit is disabled by check of G2G_DISABLED variable or input"
+          echo "disabled=true" >> "$GITHUB_OUTPUT"
+        else
+          echo "disabled=false" >> "$GITHUB_OUTPUT"
+        fi
+
     - name: "Checkout repository"
+      if: steps.disabled-check.outputs.disabled != 'true'
       # yamllint disable-line rule:line-length
       uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
       with:
@@ -181,18 +212,21 @@ runs:
         ref: ${{ github.event.pull_request.head.sha || github.sha }}
 
     - name: "Setup Python"
+      if: steps.disabled-check.outputs.disabled != 'true'
       # yamllint disable-line rule:line-length
       uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
       with:
         python-version-file: '${{ github.action_path }}/pyproject.toml'
 
     - name: "Setup uv"
+      if: steps.disabled-check.outputs.disabled != 'true'
       # yamllint disable-line rule:line-length
-      uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78  # v7.6.0
+      uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57  # v8.0.0
       with:
         enable-cache: false
 
     - name: "Setup github2gerrit"
+      if: steps.disabled-check.outputs.disabled != 'true'
       shell: bash
       env:
         # Provide version for hatch-vcs (via setuptools-scm)
@@ -214,7 +248,7 @@ runs:
 
     - name: "Validate PR_NUMBER usage"
       # yamllint disable-line rule:line-length
-      if: ${{ github.event_name != 'workflow_dispatch' && inputs.PR_NUMBER != '' && inputs.PR_NUMBER != '0' }}
+      if: ${{ steps.disabled-check.outputs.disabled != 'true' && github.event_name != 'workflow_dispatch' && inputs.PR_NUMBER != '' && inputs.PR_NUMBER != '0' }}
       shell: bash
       run: |
         # Validate PR_NUMBER usage
@@ -223,7 +257,7 @@ runs:
         exit 2
 
     - name: "Normalize PR_NUMBER"
-      if: ${{ github.event_name == 'workflow_dispatch' }}
+      if: ${{ steps.disabled-check.outputs.disabled != 'true' && github.event_name == 'workflow_dispatch' }}
       shell: bash
       run: |
         # Normalize PR_NUMBER
@@ -243,6 +277,7 @@ runs:
         fi
 
     - name: "Extract PR number, validate context"
+      if: steps.disabled-check.outputs.disabled != 'true'
       shell: bash
       run: |
         # Extract PR number, validate context
@@ -284,6 +319,7 @@ runs:
         fi
 
     - name: "Run github2gerrit Python CLI"
+      if: steps.disabled-check.outputs.disabled != 'true'
       id: run-cli
       shell: bash
       env:
@@ -357,6 +393,7 @@ runs:
         fi
 
     - name: "Capture outputs"
+      if: steps.disabled-check.outputs.disabled != 'true'
       id: capture-outputs
       shell: bash
       # yamllint disable rule:line-length

{github2gerrit-1.1.0 → github2gerrit-1.2.1}/pyproject.toml

@@ -235,19 +235,7 @@ markers = [
 
 [tool.pyright]
 pythonVersion = "3.11"
-include = ["src", "tests"]
-exclude = [
-  "build/",
-  "dist/",
-  "docs/",
-  "scripts/",
-  "tests/fixtures/",
-  ".venv/",
-  ".mypy_cache/",
-  ".pytest_cache/",
-  ".ruff_cache/",
-  "coverage_html_report/",
-]
+include = ["src"]
 typeCheckingMode = "strict"
 reportMissingImports = "none"
 reportMissingTypeStubs = "none"

{github2gerrit-1.1.0 → github2gerrit-1.2.1}/src/github2gerrit/cli.py

@@ -845,6 +845,14 @@ def main(
             typer.echo("Version information not available")
         sys.exit(int(ExitCode.SUCCESS))
 
+    # Check if GitHub2Gerrit is disabled via environment variable
+    if env_bool("G2G_DISABLED"):
+        typer.echo(
+            "\U0001f6d1 GitHub2Gerrit is disabled by check of "
+            "G2G_DISABLED variable"
+        )
+        sys.exit(int(ExitCode.SUCCESS))
+
     # Override boolean parameters with properly parsed environment variables.
     # This ensures that string "false" from GitHub Actions is handled
     # correctly (Typer/Click treats any non-empty string as truthy).
@@ -2218,7 +2226,7 @@ def _process() -> None:
             ):
                 try:
                     log.debug(
-                        "🔍 Checking for Gerrit change to abandon for PR #%s",
+                        "Checking for Gerrit change to abandon for PR #%s",
                         gh.pr_number,
                     )
                     change_number = abandon_gerrit_change_for_closed_pr(
@@ -2230,16 +2238,29 @@ def _process() -> None:
                         progress_tracker=None,
                     )
                     if change_number:
-                        gerrit_change_url = (
-                            f"https://{data.gerrit_server}/c/"
-                            f"{data.gerrit_project}/+/{change_number}"
-                        )
-                        log.debug(
-                            "✅ Successfully abandoned Gerrit change %s "
-                            "for pull request #%s",
-                            gerrit_change_url,
-                            gh.pr_number,
-                        )
+                        try:
+                            from .gerrit_urls import create_gerrit_url_builder
+
+                            _url_builder = create_gerrit_url_builder(
+                                data.gerrit_server
+                            )
+                            gerrit_change_url = _url_builder.change_url(
+                                data.gerrit_project,
+                                int(change_number),
+                            )
+                            log.debug(
+                                "Successfully abandoned Gerrit "
+                                "change %s for pull request #%s",
+                                gerrit_change_url,
+                                gh.pr_number,
+                            )
+                        except Exception:
+                            log.debug(
+                                "Successfully abandoned Gerrit "
+                                "change %s for pull request #%s",
+                                change_number,
+                                gh.pr_number,
+                            )
                         # Console output already done by
                         # abandon_gerrit_change_for_closed_pr
                     else:
@@ -2287,7 +2308,7 @@ def _process() -> None:
                     log.warning("Gerrit cleanup failed: %s", exc)
 
             log.debug(
-                "✅ Cleanup operations completed for closed PR #%s",
+                "Cleanup operations completed for closed PR #%s",
                 gh.pr_number or "unknown",
             )
             return

{github2gerrit-1.1.0 → github2gerrit-1.2.1}/src/github2gerrit/commit_normalization.py

@@ -401,8 +401,9 @@ class CommitNormalizer:
         # Remove trailing ellipsis
         title = re.sub(r"\s*[.]{3,}.*$", "", title)
 
-        # Remove markdown formatting
-        title = re.sub(r"[*_`]", "", title)
+        # Remove markdown bold/code formatting but preserve underscores
+        # (which appear in package names and filesystem paths).
+        title = re.sub(r"[*`]", "", title)
 
         # For dependabot titles, extract the essential information
         for pattern in DEPENDABOT_PATTERNS:

{github2gerrit-1.1.0 → github2gerrit-1.2.1}/src/github2gerrit/core.py

@@ -154,6 +154,93 @@ def _clean_ellipses_from_message(message: str) -> str:
     return "\n".join(cleaned_lines)
 
 
+def _clean_squash_title_line(title_line: str | None) -> str:
+    """Clean and truncate a squashed commit title line.
+
+    Handles markdown removal, separator splitting, and length
+    truncation while preserving conventional commit prefixes
+    and underscores in package/path names.
+
+    Args:
+        title_line: Raw title line from git log output.
+
+    Returns:
+        Cleaned title line, safe for use as a commit subject.
+    """
+    from .similarity import CC_PREFIX_RE
+
+    if not title_line:
+        return ""
+
+    # Remove markdown links
+    title_line = re.sub(r"\[([^\]]+)\]\([^)]+\)", r"\1", title_line)
+    # Remove trailing ellipsis/truncation
+    title_line = re.sub(r"\s*[.]{3,}.*$", "", title_line)
+    # Split on common separators to avoid leaking body content
+    for separator in [". Bumps ", " Bumps ", ". - ", " - "]:
+        if separator in title_line:
+            title_line = title_line.split(separator)[0].strip()
+            break
+    # Remove markdown bold/code formatting but preserve underscores
+    # (which appear in package names and filesystem paths).
+    title_line = re.sub(r"[*`]", "", title_line).strip()
+
+    if len(title_line) > 100:
+        # Detect conventional commit prefix length so that the
+        # ": " break-point does not split on the prefix separator
+        # (e.g. "Build(deps): " should not be treated as a sentence
+        # break).
+        cc_match = CC_PREFIX_RE.match(title_line)
+        cc_prefix_len = cc_match.end() if cc_match else 0
+
+        break_points = [". ", "! ", "? ", " - ", ": "]
+        max_bp_len = max(len(bp) for bp in break_points)
+        truncated = False
+        for bp in break_points:
+            # For the ": " break-point, start searching after the
+            # conventional commit prefix to avoid splitting there.
+            search_start = cc_prefix_len if bp == ": " else 0
+            # Extend the slice by (max_bp_len - 1) so that a
+            # break-point starting just before position 100 is
+            # still detected even if it spans across the boundary.
+            candidate_end = min(len(title_line), 100 + max_bp_len - 1)
+            candidate = title_line[search_start:candidate_end]
+            bp_offset = candidate.find(bp)
+            if bp_offset != -1:
+                bp_idx = search_start + bp_offset
+                # Only use this break-point if it starts within
+                # the 100-char limit.
+                if bp_idx >= 100:
+                    continue
+                # Punctuation break-points (". ", ": ") — include
+                # the punctuation mark.  Separator break-points
+                # (" - ") — truncate before the separator.
+                if bp[0].isspace():
+                    title_line = title_line[:bp_idx].rstrip()
+                else:
+                    title_line = title_line[
+                        : bp_idx + len(bp.rstrip())
+                    ].rstrip()
+                truncated = True
+                break
+
+        if not truncated and cc_prefix_len == 0:
+            # Non-CC title with no break-point found: fall back
+            # to word-boundary truncation at 100 characters.
+            words = title_line[:100].split()
+            title_line = (
+                " ".join(words[:-1])
+                if len(words) > 1
+                else title_line[:100].rstrip()
+            )
+        # For CC titles with no break-point: pass through the
+        # full title.  The length is inherent to the structured
+        # subject (e.g. long dependency paths), not body-content
+        # leakage.
+
+    return title_line
+
+
 # ---------------------
 # Utility functions
 # ---------------------
@@ -678,6 +765,9 @@ class Orchestrator:
         2. GitHub-Hash trailer matching
         3. GitHub-PR trailer URL matching
         4. Mapping comment parsing from PR comments
+        5. Dependency package match — find an open change that
+           bumps the same dependency (for Dependabot / Renovate
+           supersession).
 
         Args:
             gh: GitHub context containing PR information
@@ -793,6 +883,10 @@ class Orchestrator:
             except Exception as exc:
                 log.debug("GitHub-Hash trailer query failed: %s", exc)
 
+        # Cache the PR title for reuse across strategies 4 and 5
+        # so we don't duplicate GitHub API requests.
+        cached_pr_title: str = ""
+
         # Strategy 4: Parse mapping comments from PR
         try:
             from .mapping_comment import parse_mapping_comments
@@ -800,6 +894,7 @@ class Orchestrator:
             client_gh = build_client()
             repo = get_repo_from_env(client_gh)
             pr_obj = get_pull(repo, int(gh.pr_number))
+            cached_pr_title = getattr(pr_obj, "title", "") or ""
 
             issue = pr_obj.as_issue()
             comments = list(issue.get_comments())
@@ -830,6 +925,110 @@ class Orchestrator:
         except Exception as exc:
             log.debug("Mapping comment parsing failed: %s", exc)
 
+        # Strategy 5: Dependency package match (supersession)
+        # When a new Dependabot/Renovate PR bumps the same dependency
+        # as an existing open Gerrit change, reuse that Change-Id so
+        # the push creates a new patchset instead of a duplicate change.
+        try:
+            from .gerrit_query import GerritChange
+            from .gerrit_query import query_open_changes_by_project
+            from .gerrit_rest import build_client_for_host
+            from .similarity import extract_dependency_package_from_subject
+            from .trailers import GITHUB_PR_TRAILER
+            from .trailers import parse_trailers
+
+            # Reuse PR title cached by Strategy 4 to avoid a
+            # duplicate GitHub API request.
+            pr_title = cached_pr_title
+            if not pr_title:
+                log.debug(
+                    "Strategy 5: PR title cache miss, fetching from GitHub API",
+                )
+                try:
+                    gh_client = build_client()
+                    gh_repo = get_repo_from_env(gh_client)
+                    pr_obj = get_pull(gh_repo, int(gh.pr_number))
+                    pr_title = getattr(pr_obj, "title", "") or ""
+                except Exception:
+                    pr_title = ""
+
+            current_pkg = extract_dependency_package_from_subject(pr_title)
+            if current_pkg:
+                log.debug(
+                    "Strategy 5: searching for open changes that "
+                    "bump dependency '%s'",
+                    current_pkg,
+                )
+                dep_client = build_client_for_host(gerrit.host)
+                open_changes = query_open_changes_by_project(
+                    dep_client,
+                    gerrit.project,
+                    branch=gh.base_ref,
+                    max_results=200,
+                )
+
+                # Collect all matching changes, then select the
+                # oldest one (lowest change number) to avoid
+                # "downgrading" a newer change by uploading an
+                # older patchset to it.
+                candidates: list[tuple[int, GerritChange]] = []
+                for change in open_changes:
+                    candidate_pkg = extract_dependency_package_from_subject(
+                        change.subject
+                    )
+                    if candidate_pkg and candidate_pkg == current_pkg:
+                        # Verify this is a GitHub2Gerrit change
+                        commit_msg = change.commit_message or ""
+                        trailers = parse_trailers(commit_msg)
+                        if GITHUB_PR_TRAILER not in trailers:
+                            log.debug(
+                                "Strategy 5: skipping change %s "
+                                "(no GitHub2Gerrit metadata)",
+                                change.number,
+                            )
+                            continue
+                        try:
+                            change_num = int(change.number)
+                        except (TypeError, ValueError):
+                            log.debug(
+                                "Strategy 5: skipping change with "
+                                "invalid number %r for subject %r",
+                                change.number,
+                                change.subject,
+                            )
+                            continue
+                        candidates.append((change_num, change))
+
+                if candidates:
+                    # Prefer the oldest open change so the newest
+                    # PR always updates the original change and
+                    # the post-push sweep abandons the rest.
+                    candidates.sort(key=lambda t: t[0])
+                    _, oldest = candidates[0]
+                    change_ids = [oldest.change_id]
+                    log.info(
+                        "Found superseding target by dependency "
+                        "package '%s': change %s (%s) "
+                        "(oldest of %d candidate(s))",
+                        current_pkg,
+                        oldest.number,
+                        oldest.subject,
+                        len(candidates),
+                    )
+                    return change_ids
+
+                log.debug(
+                    "No open changes found for dependency '%s'",
+                    current_pkg,
+                )
+            else:
+                log.debug(
+                    "Strategy 5 skipped: could not extract dependency "
+                    "package from PR title"
+                )
+        except Exception as exc:
+            log.debug("Dependency package strategy failed: %s", exc)
+
         log.warning(
             "⚠️  No existing Gerrit changes found for PR #%s",
             gh.pr_number,
@@ -1936,6 +2135,49 @@ class Orchestrator:
         # Validate that no unexpected files were committed
         self._validate_committed_files(gh, result)
 
+        # Post-push supersession sweep (Option A fallback).
+        # After a successful push, check whether other open Gerrit
+        # changes in the same project bump the same dependency
+        # package.  If Strategy 5 already reused the old Change-Id
+        # (update-in-place), no duplicates should exist.  If that
+        # path was skipped (e.g. non-dependency PR, or the query
+        # failed), this sweep catches and abandons stale changes.
+        if not inputs.dry_run and gerrit and prep.change_ids:
+            try:
+                from .gerrit_pr_closer import (
+                    abandon_superseded_dependency_changes,
+                )
+
+                # Derive the subject from the pushed commit,
+                # regardless of whether change URL lookup
+                # succeeded.
+                push_subject = ""
+                try:
+                    push_subject = run_cmd(
+                        [
+                            "git",
+                            "show",
+                            "-s",
+                            "--pretty=format:%s",
+                            "HEAD",
+                        ],
+                        cwd=self.workspace,
+                    ).stdout.strip()
+                except Exception:
+                    push_subject = ""
+
+                if push_subject:
+                    abandon_superseded_dependency_changes(
+                        gerrit_server=gerrit.host,
+                        gerrit_project=gerrit.project,
+                        current_subject=push_subject,
+                        exclude_change_ids=prep.change_ids,
+                        dry_run=False,
+                        target_branch=self._resolve_target_branch(),
+                    )
+            except Exception as exc:
+                log.debug("Post-push supersession sweep skipped: %s", exc)
+
         self._close_pull_request_if_required(gh)
 
         log.debug("Pipeline complete: %s", result)
@@ -3564,32 +3806,7 @@ class Orchestrator:
             return message_lines, signed_off, change_ids
 
         def _clean_title_line(title_line: str) -> str:
-            # Remove markdown links
-            title_line = re.sub(r"\[([^\]]+)\]\([^)]+\)", r"\1", title_line)
-            # Remove trailing ellipsis/truncation
-            title_line = re.sub(r"\s*[.]{3,}.*$", "", title_line)
-            # Split on common separators to avoid leaking body content
-            for separator in [". Bumps ", " Bumps ", ". - ", " - "]:
-                if separator in title_line:
-                    title_line = title_line.split(separator)[0].strip()
-                    break
-            # Remove simple markdown/formatting artifacts
-            title_line = re.sub(r"[*_`]", "", title_line).strip()
-            if len(title_line) > 100:
-                break_points = [". ", "! ", "? ", " - ", ": "]
-                for bp in break_points:
-                    if bp in title_line[:100]:
-                        title_line = title_line[
-                            : title_line.index(bp) + len(bp.strip())
-                        ]
-                        break
-                else:
-                    words = title_line[:100].split()
-                    title_line = (
-                        " ".join(words[:-1])
-                        if len(words) > 1
-                        else title_line[:100].rstrip()
-                    )
+            title_line = _clean_squash_title_line(title_line)
 
             # Apply conventional commit normalization if enabled
             if inputs.normalise_commit and gh.pr_number: