Git Workflow in the Translator
- Aryn Wiebe
IguanaX leverages Git version control for efficient, collaborative and safe development. The following example provides a basic Git workflow when developing in the Translator:
CLONE a central repository and pull it down to a local machine. For example:
In IguanaX, when you Create a Component or From URL, we are performing a git clone of an upstream repository, making a copy and pulling the component repository down to your local machine for you to use.
When you clone a component repository you have two options:
Edit Original: If you have edit permissions on the component’s upstream repository, you can choose for your local component to stay connected to the upstream repository and edit the component directly.
Make a Copy and Edit: If you don’t have edit permissions or you want to connect the component to a new upstream repository, you can make a new local copy of the component and set a new upstream repository. In the Translator you can use the menu bar to connect your component to a repository.
As you make changes to your interface script, its recommended to make incremental COMMITs, saving your work at multiple milestones. This is easier for overall team collaboration, debugging and reducing risk as you make and test changes.
In the Translator, you can easily commit changes using the menu bar:
You can leave a commit note and see a diff view of your changes:
The Translator's Git terminal will appear and show you the results of your commit:
You may have noticed, when you make a commit in the Translator, IguanaX first performs a git ADD to add files the the project. This removes a step for you!
In the Translator, you can also use the Component Commit History to view the complete commit history and access any specific commits for more details.
If your team is working on the same project, there may be a new version you need to PULL down to your local project from the original upstream repository. It's important to pull down the latest changes first so you can resolve any conflicts before you share your changes.
In the Translator you can use the menu bar to pull down changes from the connected upstream repository:
When there are changes to pull down, you will be alerted with a blue dot over the pull icon.
When changes are pulled down, you can clearly view the changes. This process involves reviewing and resolving the merge conflicts - you can view the incoming changes and choose to:
Use Current - your local version;
Use Incoming - the upstream repo version; or
Use Both - can modify the code to correctly leverage both versions (if there are no conflicts or errors, Iguana will automatically choose this).
On a pull, Iguana automatically performs a git clean to remove any untracked files or directories.
You will need to again COMMIT any changes you’ve made before pushing your code to the upstream repository.
When you are ready to publish your changes to the upstream repository to share with the rest of your team you need to PUSH your changes.
In the Translator, you can easily commit changes using the menu bar:
This cycle then starts over as you make more EDITs to your project.
If Git is new to you, see What is Source Control?.