DocumentationCommerceTools

Set up the GitHub integration for Patching Automation

Last update: August 26, 2026

CREATED FOR:

  • Experienced
  • Admin
  • Developer

If your Adobe Commerce Cloud project is connected to a GitHub repository, you must install the Patching Automation GitHub App before you can use the service to apply or revert patches. The app grants the service the access it needs to make changes to your repository on your behalf.

Prerequisites

  • An active Adobe Commerce Cloud subscription
  • A GitHub integration already configured for your Adobe Commerce Cloud project, with its fetch-branches option enabled. Patching Automation creates and pushes temporary integration-environment branches, so patch operations fail to create the environment when this option is disabled.
  • A repository hosted on github.com. GitHub integrations configured with a custom domain are not supported.
  • Owner or Admin access to the GitHub organization or repository

Install the Patching Automation GitHub App

You can start the installation from Patching Automation by clicking Install GitHub App in the UI, which redirects you to the installation page, or by navigating directly to the installation page.

  1. Open the Patching Automation GitHub App installation page.
  2. Click Install.
  3. Select the GitHub organization that owns your Adobe Commerce repository.
  4. Under Repository access, select Only select repositories and choose the repository for your Adobe Commerce project.
  5. Click Install to confirm.

Once installed, the service automatically detects your GitHub connection and uses the app for all patch operations. No further setup is required.

Check and manage the connection status

The Patching Automation UI shows the current status of your GitHub connection, with actions available depending on that status:

  • Refresh / Refresh status - Re-checks the connection status without making any changes.
  • Reinstall - Shown if the installation is no longer valid (for example, if it was suspended, or the repository connected to your Cloud project changed). Starts the same installation flow described above.
  • Unlink GitHub App - Removes Patching Automation’s saved connection to the GitHub App. This does not uninstall the app from your GitHub repository — to fully remove access, see the Uninstall section below.

Uninstall the Patching Automation GitHub App

If you no longer want the service to access your repository:

  1. In GitHub, open the settings for the account that owns the installation:

    • For an organization-owned repository: Organization settings > Third-party Access > GitHub Apps.
    • For a personal repository: Settings > Applications > Installed GitHub Apps.

  2. Find adobe-commerce-patching-automation and click Configure.

  3. Click Uninstall and confirm.

WARNING
If any apply or revert operations are still in progress when the GitHub App is uninstalled, those operations may fail. After uninstalling the app, users also cannot start new operations because the action buttons become inactive.
recommendation-more-help
commerce-operations-help-tools