Using EGIT with Convertigo

Convertigo Studio can be used with EGIT to share projects on GitHub or any other GIT compatible repositories. This post explains how to use EGIT and how to share / clone projects.

Installing EGIT

By default, Convertigo Studio is not providing the EGIT plugin. You can install it easily this way :

  • Help->Install New Software…
  • Type the http://download.eclipse.org/egit/updates URL in the “Work with” input box, click the “Add…” Button and click “Ok” in the dialog box
  • Click the Checkbox near the “Git integration for Eclipse”
  • Click “Next>” and Again “Next>”, accept the license and click “Finish”
EGit_plugin_installation_01 EGit_plugin_installation_06 EGit_plugin_installation_07

The EGIT plugin will be installed on your Studio and you will have to restart it to use it.

Cloning (Importing) a project from GitHub to Convertigo Studio

  • Open the Git perspective: Window->Perspective->Open Perspective->Other.. and choose Git and click “Ok”
  • Click on the “Clone a Git repository” icon (The second “Git” icon in the “Git repositories” view
  • Fill the “URI” field with the GitHub repository URL (eg: https://github.com/convertigo/FlightShare). “Host”, “Repository path” and “protocol” will be automatically filled in
  • Fill in your username and password for GitHub account and check the “Store in Secure Store” if you want
  • Select the Branch (usually ‘master’) and click “Next>”
  • !!! VERY IMPORTANT !!!” be sure to browse to your Workspace folder so that the Directory field look like this : <Workspace Path>/<NameOfYourProject>
  • Click “Import all existing projects after clone finishes”
  • Click “Finish”
  • In the Studio “Projects” view, go to File->Import…->Convertigo->Convertigo project, then browse to your <projectName>.xml file and click “Finish”
EGit_plugin_clone_01 EGit_plugin_clone_02 EGit_plugin_clone_03 EGit_plugin_clone_05 EGit_plugin_clone_06

Sharing a project to GitHub

You can share your project on GitHub by creating a Git repository for your project. It is very important that the repository is created in the project directory itself. If not, you will not be able to share your project properly. To do so, follow these instructions:

  • In the project view, click on the “Project Explorer” tab to show Convertigo projects in files mode
  • Right-click on the project you want to share and choose Team->Share project, Select “Git” as repository type and click “Next>”
  • !!! VERY IMPORTANT !!!” Be sure to check the “Use or Create repository in parent folder of project”
  • Highlight the project in the list by clicking on it. The “Create Repository” button will then be available. Ignore the warning message saying that it is not recommended to create repositories in Eclipse workspace and click the “Create Repository” button
  • Click the “Finish” button
  • Your Project will not be placed under Git version control yet and you will be able to publish it on GitHub this way:

    • First, you have to mark some folders to Ignore for Git version control. To do so, right-click on “_private” folder and do Team->Ignore. Do the same for “DisplayObjects/mobile/build” folder
    • Then do your first commit: Right-Click on project Team->Commit… The Git Staging view will appear, select all the Unstaged changes in the “Unstaged Changes” window and Drag & Drop them in the “Staged changes” Window. Enter a commit message, for example, “First Commit” and click the “Commit” Button.
    • You can now upload your project to GitHub, Right-click on Project then, “Team->Push Branch master…”
    • Configure your GitHub URI (You must create the Repository on GitHub first)
    • Configure your GitHub credentials
    • Click “Finish” button
    EGit_plugin_share_01 EGit_plugin_share_02 EGit_plugin_share_03

    The project will be uploaded to GitHub and other developers will be able to clone the project and modify it. Each time you modify the project the <project>.xml will be modified and you will be able to commit it. You also have a “commit and push” button to immediately update GitHub after a commit.

Leave a comment