Interactions with git when applying changes
The Moderne platform consists of a set of serialized abstract syntax trees (ASTs). Inside each AST is a record of the repository that the AST was produced from as well as the branch and commit that it was produced from.
When a recipe is ran against that AST, a diff is produced that assumes the starting point for the change is the commit that the AST was produced from. However, there could have been further commits on that branch head since the AST was built.
The head of a branch is the latest commit of that branch from the perspective of the remote.
Regardless of whether you choose to initiate an action to direct commit the changes, push to a branch, push to a fork branch, or create a pull request, Moderne must first reconcile the patch changes with the latest branch head. The action type dictates which branch we are reconciling against.
To illustrate the reconciliation process, suppose you are attempting to make a direct commit to the main branch of the remote.
In this example, the AST that Moderne is operating on was produced from commit b93f7b8, which at that time was the latest head of the main branch. However, between the build of the AST and when we initiate this commit action, there has been more commits on the main branch.
  1. 1.
    Moderne first clones the main branch, checks out b93f7b8.
  2. 2.
    We are now in a detached head state, so a local branch is created from that commit. The local branch is temporary and has a generated name that is different from any existing branch.
  3. 3.
    The diff generated by Moderne is applied and the results are committed. We are now at hash 95ba902.
  4. 4.
    A rebase from main is performed, and we are now on commit 332922f. If the rebase uncovers conflicts, the operation fails at this point. This prevents us from doing anything unsafe, and provided that you are regularly building ASTs from each branch head, the recipe can be reran in a few minutes once the new AST has been produced and published to the platform.
  5. 5.
    Checkout main (the branch we intend to push changes to).
  6. 6.
    Rebase from the temporary branch. This will always trivially succeed if the rebase in step 4 succeeded because any conflicts would have been uncovered there. We are now at commit 4976bb0, a commit exactly one step ahead of the latest head on main incorporating changes from the patch and any commits that happened between when the AST was built and now.
  7. 7.
    If we have made it to this point, we can push the results!
Export as PDF
Copy link