Skip to content

Changes to branching and versioning

Anoop edited this page Mar 19, 2023 · 3 revisions

Reason for the change in branching

Like Frappe HR and other apps dependent on ERPNext, Frappe Health has also introduced similar branching and versioning.

From now on the version-14 branch of Frappe Health will be compatible with ERPNext's version-14 branch. This branch has been named version-14 to keep it consistent with Frappe & ERPNext's.

Compatibility

In order to continue the convention of introducing breaking changes in develop, the branch compatibility will be as follows:

Frappe's Branch Frappe Health's Branch
version-14 version-14
develop develop
  • If you are on version-14 of ERPNext: Some manual intervention will be required to switch Frappe Health to the stable branch (steps mentioned below). If you are using Frappe/ERPNext v14 and Frappe Health's v15(develop), then a patch will stop your migration and ask you to switch the branch before migrating.

  • If you are on develop branch of ERPNext: You don't need to do anything.

New PRs and cloning:

  • A new branch called version-14-hotfix will serve as the staging area for code that is pending to be released into version-14 (similar to ERPNext). All pull requests intended for version-14 need to be made to this branch.

  • The develop branch of Frappe Health will continue to be compatible with ERPNext/Frappe's develop branch.

  • develop will also be the default branch for all new clones (bench get-app ...). If you want to clone and install a stable version of Frappe Health, you will have to use the --branch flag like so:

bench get-app health --branch version-14

Steps to switch to the desired branch from the develop branch

For general users

Execute the following commands from your bench directory (e.g. frappe-bench):

bench switch-to-branch version-14 health # version-14-hotfix if you wish to switch to the hotfix branch

And then proceed with the migration with

bench --site [sitename] migrate or bench update

For Frappe Cloud Users

For all the benches (public/private) using Frappe version-14, Frappe Health's branch has been changed to version-14 already. They will receive an update for the site.

Make sure you select version-14 for new production sites. Just for reference, here is how you can switch branch on FC from Bench > Apps:

  • Click on the menu against the Frappe Health app and Change Branch.

    change-branch
  • Select version-14 and update your bench and sites

    change-branch-2