Installing a pull request on your store

When you're experiencing a bug that already has an open Pull Request (PR), you may want to apply the patch before an official release. Additionally, we may sometimes ask you to test a patch to confirm if a fix works in your specific setup.

Applying a patch isn't difficult, but it involves a few steps. Follow this guide to get started.

Installing a patch isn't very difficult, but it requires a few steps.

Step 1:

Identify the correct Pull Request. You can find an overview here: https://github.com/mollie/magento2/pulls

Step 2

Check if the cweagans/composer-patches plugin is already installed. If not, install it by running:

composer require cweagans/composer-patches

During installation, you might see this prompt:

Do you trust "cweagans/composer-patches" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?]

Type "Y" and press Enter.

Step 3

Update your composer.json by adding the patch. Please note that the extra key might already exists, and it might already have a patches key too. You should merge any existing keys.

The URL of the patch is the same as when opening the issue in your browser, but with .patch added to the URL. For example, when you try to install this Pull Request:

https://github.com/mollie/magento2/pull/<PULL_REQUEST_NUMBER>

The URL will become:

https://github.com/mollie/magento2/pull/<PULL_REQUEST_NUMBER>.patch

How your composer.json should look like:

  "extra": {
    "patches": {
      "mollie/magento2": {
        "Name of the issue": "https://github.com/mollie/magento2/pull/<PULL_REQUEST_NUMBER>.patch"
      }
    }
  }

Step 4

Run composer update mollie/magento2. You should see a message that looks like this:

- Applying patches for mollie/magento2
    https://patch-diff.githubusercontent.com/raw/mollie/magento2/pull/<PULL_REQUEST_NUMBER.patch (Name of the issue)

That's it!

If you ever want to remove the patch, remove the record from composer.json and run composer update mollie/magento2 again.