ci: add github auto-merge support, disable 'skip-ci' marker, use specific tags in commit messages (#61598)

aaronsteers · octavia-squidington-iii · web-flow · commit 4fdba3989cbf · 2025-06-14T13:44:40.000-07:00
Co-authored-by: Octavia Squidington III &lt;octavia-squidington-iii@users.noreply.github.com&gt;
diff --git a/airbyte-ci/connectors/auto_merge/src/auto_merge/main.py b/airbyte-ci/connectors/auto_merge/src/auto_merge/main.py
@@ -12,7 +12,13 @@
 
 from github import Auth, Github
 
-from .consts import AIRBYTE_REPO, AUTO_MERGE_BYPASS_CI_CHECKS_LABEL, AUTO_MERGE_LABEL, BASE_BRANCH, MERGE_METHOD
+from .consts import (
+    AIRBYTE_REPO,
+    AUTO_MERGE_BYPASS_CI_CHECKS_LABEL,
+    AUTO_MERGE_LABEL,
+    BASE_BRANCH,
+    MERGE_METHOD,
+)
 from .env import GITHUB_TOKEN, PRODUCTION
 from .helpers import generate_job_summary_as_markdown
 from .pr_validators import VALIDATOR_MAPPING
@@ -70,11 +76,23 @@ def get_pr_validators(pr: PullRequest) -> set[Callable]:
     Returns:
         list[callable]: The validators
     """
-
+    validators: set[Callable] = set()
     for label in pr.labels:
         if label.name in VALIDATOR_MAPPING:
-            return VALIDATOR_MAPPING[label.name]
-    return VALIDATOR_MAPPING[AUTO_MERGE_LABEL]
+            # Add these to our validators set:
+            validators |= VALIDATOR_MAPPING[label.name]
+
+    if not validators:
+        # We shouldn't reach this point, but if we do, we raise an error.
+        # TODO: We could consider returning a dummy callable which always returns False,
+        # but for now, we raise an error to ensure we catch any misconfigurations.
+        raise ValueError(
+            f"PR #{pr.number} does not have a valid auto-merge label. "
+            f"Expected one of [{', '.join(VALIDATOR_MAPPING.keys())}], but got: "
+            f"[{'; '.join(label.name for label in pr.labels)}]",
+        )
+
+    return validators
 
 
 def merge_with_retries(pr: PullRequest, max_retries: int = 3, wait_time: int = 60) -> Optional[PullRequest]:
@@ -157,7 +175,9 @@ def auto_merge() -> None:
             f"repo:{AIRBYTE_REPO} is:pr label:{AUTO_MERGE_LABEL},{AUTO_MERGE_BYPASS_CI_CHECKS_LABEL} base:{BASE_BRANCH} state:open"
         )
         prs = [issue.as_pull_request() for issue in candidate_issues]
-        logger.info(f"Found {len(prs)} open PRs targeting {BASE_BRANCH} with the {AUTO_MERGE_LABEL} label")
+        logger.info(
+            f"Found {len(prs)} open PRs targeting {BASE_BRANCH} with the '{AUTO_MERGE_LABEL}' or '{AUTO_MERGE_BYPASS_CI_CHECKS_LABEL}' label"
+        )
         merged_prs = []
         for pr in prs:
             back_off_if_rate_limited(gh_client)
diff --git a/airbyte-ci/connectors/auto_merge/src/auto_merge/pr_validators.py b/airbyte-ci/connectors/auto_merge/src/auto_merge/pr_validators.py
@@ -4,7 +4,12 @@
 
 from typing import TYPE_CHECKING, Callable, Optional, Tuple
 
-from .consts import AUTO_MERGE_BYPASS_CI_CHECKS_LABEL, AUTO_MERGE_LABEL, BASE_BRANCH, CONNECTOR_PATH_PREFIXES
+from .consts import (
+    AUTO_MERGE_BYPASS_CI_CHECKS_LABEL,
+    AUTO_MERGE_LABEL,
+    BASE_BRANCH,
+    CONNECTOR_PATH_PREFIXES,
+)
 
 if TYPE_CHECKING:
     from github.Commit import Commit as GithubCommit
@@ -71,6 +76,10 @@ def head_commit_passes_all_required_checks(
 }
 # Let's declare faster checks first as the check_if_pr_is_auto_mergeable function fails fast.
 VALIDATOR_MAPPING: dict[str, set[Callable]] = {
+    # Until we have an auto-approve mechanism, we use this pipeline to force-merge,
+    # as long as all required checks pass. This doesn't bypass checks but it bypasses the
+    # approval requirement:
     AUTO_MERGE_LABEL: COMMON_VALIDATORS | {has_auto_merge_label, head_commit_passes_all_required_checks},
+    # These are pure registry updates, and can be auto-merged without any CI checks:
     AUTO_MERGE_BYPASS_CI_CHECKS_LABEL: COMMON_VALIDATORS | {has_auto_merge_bypass_ci_checks_label},
 }
diff --git a/airbyte-ci/connectors/pipelines/README.md b/airbyte-ci/connectors/pipelines/README.md
@@ -822,6 +822,7 @@ airbyte-ci connectors --language=low-code migrate-to-manifest-only
 
 | Version | PR                                                          | Description                                                                                                                  |
 | ------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| 5.3.0   | [#61598](https://github.com/airbytehq/airbyte/pull/61598)  | Add trackable commit text and github-native auto-merge in up-to-date, auto-merge, rc-promote, and rc-rollback |
 | 5.2.5   | [#60325](https://github.com/airbytehq/airbyte/pull/60325)  | Update slack team to oc-extensibility-critical-systems |
 | 5.2.4   | [#59724](https://github.com/airbytehq/airbyte/pull/59724)  | Fix components mounting and test dependencies for manifest-only unit tests |
 | 5.1.0   | [#53238](https://github.com/airbytehq/airbyte/pull/53238)  | Add ability to opt out of version increment checks via metadata flag                                                         |
diff --git a/airbyte-ci/connectors/pipelines/pipelines/airbyte_ci/connectors/publish/pipeline.py b/airbyte-ci/connectors/pipelines/pipelines/airbyte_ci/connectors/publish/pipeline.py
@@ -1,6 +1,7 @@
 #
 # Copyright (c) 2023 Airbyte, Inc., all rights reserved.
 #
+from __future__ import annotations
 
 import json
 import os
@@ -15,7 +16,15 @@
 from airbyte_protocol.models.airbyte_protocol import ConnectorSpecification  # type: ignore
 from auto_merge.consts import AUTO_MERGE_BYPASS_CI_CHECKS_LABEL  # type: ignore
 from connector_ops.utils import METADATA_FILE_NAME, ConnectorLanguage  # type: ignore
-from dagger import Container, Directory, ExecError, File, ImageLayerCompression, Platform, QueryError
+from dagger import (
+    Container,
+    Directory,
+    ExecError,
+    File,
+    ImageLayerCompression,
+    Platform,
+    QueryError,
+)
 from pydantic import BaseModel, ValidationError
 
 from pipelines import consts
@@ -26,7 +35,10 @@
 from pipelines.airbyte_ci.steps.bump_version import SetConnectorVersion
 from pipelines.airbyte_ci.steps.changelog import AddChangelogEntry
 from pipelines.airbyte_ci.steps.pull_request import CreateOrUpdatePullRequest
-from pipelines.airbyte_ci.steps.python_registry import PublishToPythonRegistry, PythonRegistryPublishContext
+from pipelines.airbyte_ci.steps.python_registry import (
+    PublishToPythonRegistry,
+    PythonRegistryPublishContext,
+)
 from pipelines.consts import LOCAL_BUILD_PLATFORM
 from pipelines.dagger.actions.remote_storage import upload_to_gcs
 from pipelines.dagger.actions.system import docker
@@ -635,12 +647,16 @@ def get_rollback_pr_creation_arguments(
     step_results: Iterable[StepResult],
     release_candidate_version: str,
 ) -> Tuple[Tuple, Dict]:
-    return (modified_files,), {
-        "branch_id": f"{context.connector.technical_name}/rollback-{release_candidate_version}",
-        "commit_message": "\n".join(step_result.step.title for step_result in step_results if step_result.success),
-        "pr_title": f"🐙 {context.connector.technical_name}: Stop progressive rollout for {release_candidate_version}",
-        "pr_body": f"The release candidate version {release_candidate_version} has been deemed unstable. This PR stops its progressive rollout. This PR will be automatically merged as part of the `auto-merge` workflow. This workflow runs every 2 hours.",
-    }
+    return (
+        (modified_files,),
+        {
+            "branch_id": f"{context.connector.technical_name}/rollback-{release_candidate_version}",
+            "commit_message": "[auto-publish] "  # << We can skip Vercel builds if this is in the commit message
+            + "; ".join(step_result.step.title for step_result in step_results if step_result.success),
+            "pr_title": f"🐙 {context.connector.technical_name}: Stop progressive rollout for {release_candidate_version}",
+            "pr_body": f"The release candidate version {release_candidate_version} has been deemed unstable. This PR stops its progressive rollout. This PR will be automatically merged as part of the `auto-merge` workflow. This workflow runs every 2 hours.",
+        },
+    )
 
 
 async def run_connector_rollback_pipeline(context: PublishConnectorContext, semaphore: anyio.Semaphore) -> ConnectorReport:
@@ -675,7 +691,14 @@ async def run_connector_rollback_pipeline(context: PublishConnectorContext, sema
 
             # Open PR when all previous steps are successful
             initial_pr_creation = CreateOrUpdatePullRequest(
-                context, skip_ci=True, labels=[AUTO_MERGE_BYPASS_CI_CHECKS_LABEL, "rollback-rc"]
+                context,
+                # We will merge even if the CI checks fail, due to this label:
+                labels=[AUTO_MERGE_BYPASS_CI_CHECKS_LABEL, "rollback-rc"],
+                # Let GitHub auto-merge this if all checks pass before the next run
+                # of our auto-merge workflow:
+                github_auto_merge=True,
+                # Don't skip CI, as it prevents the PR from auto-merging naturally:
+                skip_ci=False,
             )
             pr_creation_args, pr_creation_kwargs = get_rollback_pr_creation_arguments(all_modified_files, context, results, current_version)
             initial_pr_creation_result = await initial_pr_creation.run(*pr_creation_args, **pr_creation_kwargs)
@@ -692,12 +715,16 @@ def get_promotion_pr_creation_arguments(
     release_candidate_version: str,
     promoted_version: str,
 ) -> Tuple[Tuple, Dict]:
-    return (modified_files,), {
-        "branch_id": f"{context.connector.technical_name}/{promoted_version}",
-        "commit_message": "\n".join(step_result.step.title for step_result in step_results if step_result.success),
-        "pr_title": f"🐙 {context.connector.technical_name}: release {promoted_version}",
-        "pr_body": f"The release candidate version {release_candidate_version} has been deemed stable and is now ready to be promoted to an official release ({promoted_version}). This PR will be automatically merged as part of the `auto-merge` workflow. This workflow runs every 2 hours.",
-    }
+    return (
+        (modified_files,),
+        {
+            "branch_id": f"{context.connector.technical_name}/{promoted_version}",
+            "commit_message": "[auto-publish] "  # << We can skip Vercel builds if this is in the commit message
+            + "; ".join(step_result.step.title for step_result in step_results if step_result.success),
+            "pr_title": f"🐙 {context.connector.technical_name}: release {promoted_version}",
+            "pr_body": f"The release candidate version {release_candidate_version} has been deemed stable and is now ready to be promoted to an official release ({promoted_version}). This PR will be automatically merged as part of the `auto-merge` workflow. This workflow runs every 2 hours.",
+        },
+    )
 
 
 async def run_connector_promote_pipeline(context: PublishConnectorContext, semaphore: anyio.Semaphore) -> ConnectorReport:
@@ -742,7 +769,7 @@ async def run_connector_promote_pipeline(context: PublishConnectorContext, semap
 
             # Open PR when all previous steps are successful
             promoted_version = set_promoted_version.promoted_version
-            initial_pr_creation = CreateOrUpdatePullRequest(context, skip_ci=True)
+            initial_pr_creation = CreateOrUpdatePullRequest(context, skip_ci=False)
             pr_creation_args, pr_creation_kwargs = get_promotion_pr_creation_arguments(
                 all_modified_files, context, results, current_version, promoted_version
             )
@@ -768,7 +795,11 @@ async def run_connector_promote_pipeline(context: PublishConnectorContext, semap
                         await add_changelog_entry.export_modified_files(context.connector.local_connector_documentation_directory)
                     )
                 post_changelog_pr_update = CreateOrUpdatePullRequest(
-                    context, skip_ci=True, labels=[AUTO_MERGE_BYPASS_CI_CHECKS_LABEL, "promoted-rc"]
+                    context,
+                    skip_ci=False,  # Don't skip CI, as it prevents the PR from auto-merging naturally.
+                    # We will merge even if the CI checks fail, due to the "bypass-ci-checks" label:
+                    labels=[AUTO_MERGE_BYPASS_CI_CHECKS_LABEL, "promoted-rc"],
+                    github_auto_merge=True,  # Let GitHub auto-merge this if/when all required checks have passed.
                 )
                 pr_creation_args, pr_creation_kwargs = get_promotion_pr_creation_arguments(
                     all_modified_files, context, results, current_version, promoted_version
diff --git a/airbyte-ci/connectors/pipelines/pipelines/airbyte_ci/connectors/up_to_date/pipeline.py b/airbyte-ci/connectors/pipelines/pipelines/airbyte_ci/connectors/up_to_date/pipeline.py
@@ -62,12 +62,16 @@ def get_pr_creation_arguments(
     step_results: Iterable[StepResult],
     dependency_updates: Iterable[DependencyUpdate],
 ) -> Tuple[Tuple, Dict]:
-    return (modified_files,), {
-        "branch_id": f"up-to-date/{context.connector.technical_name}",
-        "commit_message": "\n".join(step_result.step.title for step_result in step_results if step_result.success),
-        "pr_title": f"🐙 {context.connector.technical_name}: run up-to-date pipeline [{datetime.now(timezone.utc).strftime('%Y-%m-%d')}]",
-        "pr_body": get_pr_body(context, step_results, dependency_updates),
-    }
+    return (
+        (modified_files,),
+        {
+            "branch_id": f"up-to-date/{context.connector.technical_name}",
+            "commit_message": "[up-to-date]"  # << We can skip Vercel builds if this is in the commit message
+            + "; ".join(step_result.step.title for step_result in step_results if step_result.success),
+            "pr_title": f"🐙 {context.connector.technical_name}: run up-to-date pipeline [{datetime.now(timezone.utc).strftime('%Y-%m-%d')}]",
+            "pr_body": get_pr_body(context, step_results, dependency_updates),
+        },
+    )
 
 
 ## MAIN FUNCTION
@@ -143,10 +147,13 @@ async def run_connector_up_to_date_pipeline(
 
                 # We open a PR even if build is failing.
                 # This might allow a developer to fix the build in the PR.
-                # ---
-                # We are skipping CI on this first PR creation attempt to avoid useless runs:
-                # the new changelog entry is missing, it will fail QA checks
-                initial_pr_creation = CreateOrUpdatePullRequest(context, skip_ci=True, labels=DEFAULT_PR_LABELS)
+                initial_pr_creation = CreateOrUpdatePullRequest(
+                    context,
+                    labels=DEFAULT_PR_LABELS,
+                    # Reduce pressure on rate limit, since we need to push a
+                    # a follow-on commit anyway once we have the PR number:
+                    skip_ci=True,
+                )
                 pr_creation_args, pr_creation_kwargs = get_pr_creation_arguments(
                     all_modified_files, context, step_results, dependency_updates
                 )
@@ -176,7 +183,15 @@ async def run_connector_up_to_date_pipeline(
                     context.logger.info(f"Exported files following the changelog entry: {exported_modified_files}")
                     all_modified_files.update(exported_modified_files)
                     final_labels = DEFAULT_PR_LABELS + [AUTO_MERGE_PR_LABEL] if auto_merge else DEFAULT_PR_LABELS
-                    post_changelog_pr_update = CreateOrUpdatePullRequest(context, skip_ci=False, labels=final_labels)
+                    post_changelog_pr_update = CreateOrUpdatePullRequest(
+                        context,
+                        labels=final_labels,
+                        # For this 'up-to-date' pipeline, we want GitHub to merge organically
+                        # if/when all required checks pass. Maintainers can also easily disable
+                        # auto-merge if they want to review or update the PR before merging.
+                        github_auto_merge=auto_merge,
+                        skip_ci=False,
+                    )
                     pr_creation_args, pr_creation_kwargs = get_pr_creation_arguments(
                         all_modified_files, context, step_results, dependency_updates
                     )
diff --git a/airbyte-ci/connectors/pipelines/pipelines/airbyte_ci/connectors/up_to_date/steps.py b/airbyte-ci/connectors/pipelines/pipelines/airbyte_ci/connectors/up_to_date/steps.py
@@ -27,7 +27,7 @@ class PoetryUpdate(StepModifyingFiles):
     context: ConnectorContext
     dev: bool
     specified_versions: dict[str, str]
-    title = "Update versions of libraries in poetry."
+    title = "Update versions of libraries in poetry"
 
     def __init__(
         self,
diff --git a/airbyte-ci/connectors/pipelines/pipelines/airbyte_ci/steps/pull_request.py b/airbyte-ci/connectors/pipelines/pipelines/airbyte_ci/steps/pull_request.py
@@ -24,10 +24,12 @@ def __init__(
         context: PipelineContext,
         skip_ci: bool,
         labels: Optional[Iterable[str]] = None,
+        github_auto_merge: bool = False,
     ) -> None:
         super().__init__(context)
         self.skip_ci = skip_ci
         self.labels = labels or []
+        self.github_auto_merge = github_auto_merge
 
     async def _run(
         self,
@@ -51,6 +53,7 @@ async def _run(
                 logger=self.logger,
                 skip_ci=self.skip_ci,
                 labels=self.labels,
+                github_auto_merge=self.github_auto_merge,
             )
         except Exception as e:
             return StepResult(step=self, status=StepStatus.FAILURE, stderr=str(e), exc_info=e)
diff --git a/airbyte-ci/connectors/pipelines/pipelines/helpers/github.py b/airbyte-ci/connectors/pipelines/pipelines/helpers/github.py
@@ -137,6 +137,7 @@ def create_or_update_github_pull_request(
     skip_ci: bool = False,
     labels: Optional[Iterable[str]] = None,
     force_push: bool = True,
+    github_auto_merge: bool = False,
 ) -> github_sdk.PullRequest.PullRequest:
     logger = logger or main_logger
     g = github_sdk.Github(auth=github_sdk.Auth.Token(github_token))
@@ -222,6 +223,10 @@ def create_or_update_github_pull_request(
         pull_request.add_to_labels(label)
         logger.info(f"Added label {label} to pull request")
 
+    if github_auto_merge:
+        logger.info("Enabling (native) GitHub auto-merge for the pull request")
+        pull_request.enable_automerge("SQUASH")
+
     return pull_request
 
 
diff --git a/airbyte-ci/connectors/pipelines/pyproject.toml b/airbyte-ci/connectors/pipelines/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pipelines"
-version = "5.2.5"
+version = "5.3.0"
 description = "Packaged maintained by the connector operations team to perform CI for connectors' pipelines"
 authors = ["Airbyte <contact@airbyte.io>"]
 
