12

I am working on a Magento module that requires a quick fix. I assume I can fix it by creating Magento 2 "patch" way.

I have never created a patch file before, can anyone help me to create a patch file for a custom module?

8 Answers 8

46

I use this method for creating patch, hope it helps . Let suppose you will modify this file

vendor/magento/module-customer/Block/CustomerData.php

Create a copy of that file with your changes on it:

vendor/magento/module-customer/Block/CustomerDataModified.php

What you need to do is run this command:

diff -u CustomerData.php CustomerDataModified.php > diff.patch

Move diff.patch in your root under a directory, example Mypatches dir . Delete the file added CustomerDataModified.php since the patch is generated with the changes.

Here comes the tricky part , needs some manual modification now : When you open the diff.patch you will get something like this on the top :

--- CustomerData.php    2018-02-21 01:26:16.000000000 -0500
+++ CustomerDataModified.php    2019-01-03 03:57:47.326011737 -0500

Replace those line with this one:

diff --git a/Block/CustomerData.php b/Block/CustomerData.php
index 3ee2rd..8349152 111644
--- a/Block/CustomerData.php
+++ b/Block/CustomerData.php

The index is needed (the numbers are generated by me random, by default are generated from git but in most cases the vendor is in .gitignore)

Next Step is modification of the composer.json in the root of your magento : Add the extra section (if you dont have one already)

"extra": {
        "magento-force": "override",
        "patches": {
            "magento/module-customer": {
                "some description abt issue applying this patch": "Mypatches/diff.patch"
            }
        }
    }

And there you go . Your patch is diff.patch (you can call whatever you like ) . Run composer install to apply that

7
  • 2
    Let me know if it works for you . Jan 3, 2019 at 12:35
  • 3
    This works exactly what I am looking for. Thanks dude.
    – Charlie
    Jan 7, 2019 at 10:34
  • 1
    Glad it helped :). Jan 7, 2019 at 10:37
  • 1
    Easily Understanable @YlgenGuxholli, All type of patches generated using this formula ? Aug 10, 2019 at 6:36
  • 2
    Works as expected. Many thanks, Ylgen! Feb 6, 2020 at 10:39
30

Here is my answer, i hope it will help someone:

First make sure that this package is installed via composer: cweagans/composer-patches

Lets say you want to apply a patch from a third-party module installed via composer for a controller. Please make sure that you have this part in the composer.json file:

"extra": {
    "magento-force": true,
    "composer-exit-on-patch-failure": true,
    "patches": {
        "vendorname/module-somerandomname": {
            "Description here": "patches/my_patch_name.patch"
        }
    }
},

Assuming that your vendor folder is in the .gitignore file, you can still do:

  1. git add -f vendor/vendorname/module-somerandomname/Controller/Myfile.php
  2. Do your changes to the Myfile.php
  3. Do a git diff vendor/vendorname/module-somerandomname/Controller/Myfile.php > patches/my_patch_name.patch
  4. git reset HEAD vendor/vendorname/module-somerandomname/Controller/Myfile.php
  5. Do a composer install
4
  • 3
    Works like a charm Oct 29, 2020 at 16:14
  • 3
    This is the most elegant solution! Dec 4, 2020 at 13:33
  • 3
    This should be accepted answer Apr 28, 2021 at 19:51
  • 2
    This should be the real solution for applying patch Dec 21, 2021 at 11:51
1

For creating a patch, most of the people are using Github

At git, it is easy to create a patch for a commit. If you want to create the patch for a commit 452 then use git format-patch -1 {commitId}

Checkout below blogs:

https://coderwall.com/p/6aw72a/creating-patch-from-github-pull-request https://stackoverflow.com/questions/6658313/generate-a-git-patch-for-a-specific-commit https://gist.github.com/emmanueltissera/19d0a8852f000cde13768dd7420a0906

For magento, you can use below steps describe by magento

https://support.magento.com/hc/en-us/articles/360005484154-Create-a-patch-for-a-Magento-2-Composer-installation-from-a-GitHub-commit

0
1

If you are using Magento Cloud, you can create your patch following @Ylgen method, then move the patch to the m2-hotfixes/ folder and run:

php vendor/bin/ece-patches apply
php bin/magento cache:clean

Documentation:

https://devdocs.magento.com/cloud/project/project-patch.html#apply-a-patch-in-a-local-environment

1
  1. Add the file you want to modify::

    git add vendor/magento/module-customer/Block/CustomerData.php -f

  2. make changes to the original file

    vendor/magento/module-customer/Block/CustomerData.php

  3. git diff

    vendor/magento/module-customer/Block/CustomerData.php > yourPatchName.patch

  4. you will get the patch file (yourPatchName.patch) in the root directory

  5. remove the changes you added to the original file manually by using ctrl+z

    vendor/magento/module-customer/Block/CustomerData.php

  6. apply the patch using::

    git apply yourPatchName.patch

you will notice the changes in the original file

0

if you're using phpstorm you can simply right click on a file from local changes and select "Create patch from local changes"

enter image description here

0
  • Cloud is not accepting to move vendor files to git.

  • So i created file in app/code folder like
    app/code/vendor/magento/module-customer/Block/CustomerData.php

  • added to git then committed. Not pushed the changes to any branch.

  • Then updated the modified code then executed the git diff command. git diff app/code/vendor/magento/module-customer/Block/CustomerData.php

  • It showed the below code. diff --git a/app/code/vendor/magento/module-customer/Block/CustomerData.php b/app/code/vendor/magento/module-customer/Block/CustomerData.php index 3ee2rd..8349152 111644 --- a/app/code/vendor/magento/module-customer/Block/CustomerData.php +++ b/app/code/vendor/magento/module-customer/Block/CustomerData.php

  • I copied that above code and added in customer.patch file then removed the app/code/ code.

  • uploaded the customer.patch file from hotfixes folder then moved to the git.

  • Then remove the file from app/code/vendor/magento/module-customer/Block/CustomerData.php location then commit again.

-1

Hey can you please tell me that how to create a patch for composer.json?

1

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.