Files
alfresco-ng2-components/docs/user-guide/releasing-patches.md
2025-09-01 15:25:21 +02:00

2.3 KiB

ADF Patch Release

Below steps describe how to create a patch release for latest ADF version

  1. Patching ADF starts from master branch, therefore you need to be sure you have the latest master branch:

    git checkout master
    git pull
    
  2. Learn the version you would like to patch, you can check ADF versions here.

  3. Create new patch branch from master i.e. develop-patch-VERSION (e.g. develop-patch-4.11.1):

    git checkout -b develop-patch-VERSION master
    
  4. Apply and commit your fix to develop-patch-VERSION branch.

  5. Increment the version in the package.json with the following command where -v refers to the ADF version and -vj to the new js-api version. The js-api must have a major version that is one higher than the other packages. For example, if adf-core is at version 4.11.1, then js-api should be at version 5.11.1

    ./scripts/update-version.sh -v X.X.X -vj X.X.X
    
    # e.g. ./scripts/update-version.sh -v 4.1.11 -vj 5.1.11
    
  6. The "@alfresco/js-api" dependency in the lib/cli/package.json has to remain unchanged

  7. Run release.sh script with proper patch version:

    scripts/release.sh -v VERSION
    
    # e.g. scripts/release.sh -v 4.11.1
    
  8. Push your changes and run all tests:

    git push -u origin develop-patch-VERSION
    

    In order to run all tests you can use [ci:force] flag:

    git commit -m '[ci:force]' --allow-empty
    git push
    
  9. Verify if tests are green and if everything looks fine, you can proceed further.

  10. Create new branch from master and call it master-patch-VERSION (e.g. master-patch-4.11.1):

    git checkout master
    git checkout -b master-patch-VERSION
    
  11. Merge develop-patch-VERSION into master-patch-VERSION:

    git checkout master-patch-VERSION
    git merge develop-patch-VERSION
    
  12. Push master-patch-VERSION branch:

    git push -u origin master-patch-VERSION
    
  13. Verify if build is green and check if proper tag was created.

  14. After all is done, you can cherry-pick your fix to develop.