How to install SocialCDE
This plugin requires Eclipse 3.7 (Indigo) and later, or Aptana studio 3+, with Java 7+ already installed. SocialCDEforEclipse works with GitHub repositories, luckily Eclipse already provides support for handling GitHub code, but not GitHub issues, that is, the database where you create tickets for managing your development.
You need to install Aptanta Studio as an Eclipse plugin, not as standalone app. So first download Eclipse from eclipse.org/downloads, then follow these simple steps to install Aptana Studio plugins in your Eclipse installation.
To download SocialCDEforEclipse plugin for Eclipse IDE (simply, a .jar file), you have the following two choices:
- If you have received an email from the administrator, please follow the instructions provided in the e-mail. After downloading the client, please continue to read this guide from the next step.
- If you have not received an email from the administrator, please download the last version of the plugin from here.
To add SocialCDEforEclipse to Eclipse or Aptana, simply copy the downloaded jar file into the subfolder dropins/ within your installation directory (e.g, c:\users\fabio\eclipse or /home/fabio/ecplipse).
If you don’t find this folder, please control the version of your IDE of choice. If you are a Mac OS X user, make sure to right-click the Eclipse icon and pick from menu the 'Show Package Contents' entry to see the folders within.
After moving the jar, run the IDE and, once it has started, enable the plugin by selecting the menu 'Windows -> Show view -> Others' and then browsing for 'SocialCDE for Eclipse' in the tree view.
The plugin is composed by two views:
- SocialCDEforEclipse View
- SocialCDEforEclipse Browser
The first is the main view of the plugin. Feel free to position it where you like, although it works best when pinned to either side of the IDE. The browser is meant to manage the authentication procedure for social network accounts through the OAuth protocol and, therefore, it opens up automatically when needed. When it opens up, make sure to arrange (i.e., drag and drop) the browser in the middle panel, where the source file editor is, so that you have more space.
In order to let SocialCDEforEclipse works at it bests, you need to add the GitHub issue connector. The task is simple. Go to 'Help -> Install new Software' menu.
From the next form, select edit the field as shown in the figure below. Then click next and follow the on-screen instructions.
After reboot, on the right-hand side of the IDE, you will see a 'Task list' panel, as shown in the picture below. Click on the + icon to add the issue repository from one of your GitHub projects.
A wizard will drive you through the process. Select 'GitHub Issues', then click next and edit the field in the next screen as shown below. In particular, copy and paste the url of the chosen project in the 'Server' field and the field 'Label' will be populated automatically. As per 'User ID' and 'Password', enter your GitHub credentials (make sure to also check 'Save Passwords' or you will have to authenticate every time Eclipse is started).
Click 'Finish'. When asked to add a new query, say no, we will create a query in a moment. Go back and click the + button in the 'Task list' panel, as in the picture below. Let's create a new query to list some of the issues already entered in GitHub. Click on 'New query', then select the repository for your project.
Let's try and select all the issues that are open in the current sprint (or milestone, in the GitHub lingo) that have been assigned to me. Try to fill configure your own query taking inspiration from the figure below.
And below is the result of the query just created. Double-clicking on an issue, will open a form editor, where you can modify the content, comment, etc. as you do on GitHub. Clicking 'Submit' will save all the changes locally and on GitHub too.
To create a new issue, click on the + button and select 'New task', then select what GitHub issue repo you are contributing to, and fill out the form. Click on 'Submit' and the issue will be uploaded on your GitHub project space.
