Difference between revisions of "EGit/GitHub/User Guide"

From Eclipsepedia

< EGit‎ | GitHub
Jump to: navigation, search
(Overview)
(Overview)
 
(One intermediate revision by one user not shown)
Line 5: Line 5:
  
 
http://download.eclipse.org/egit/github/updates-nightly
 
http://download.eclipse.org/egit/github/updates-nightly
 
== Prerequisites ==
 
The EGit Mylyn GitHub connector depends on the [http://code.google.com/p/google-gson/ Gson] library (version 1.6 or higher) for JSON serialization/deserialization and the [http://hc.apache.org/ Apache HTTP Components] library (version 4.1.0 or higher) for HTTP requests.  These dependencies must be installed prior to installing the connector.  The Gson and HTTP Components plug-ins are not yet available from the Indigo update site so the following steps must be taken to install them from the [http://www.eclipse.org/orbit/ Orbit] update site.
 
 
* '''Help''' > '''Install New Software...'''
 
* Add a repository for http://download.eclipse.org/tools/orbit/downloads/drops/S20110422041657/repository/
 
* Select ''Gson'' from under the ''Orbit Bundles By Name: com.google.*'' category
 
* Select ''Apache HttpComponents HttpCore'' and ''Apache HttpClient OSGi bundle'' from under the ''Orbit Bundles By Name: org.apache.*'' category
 
* Select '''Next''' and complete installation
 
  
 
== Getting Started==
 
== Getting Started==

Latest revision as of 12:14, 27 May 2011

Contents

[edit] Overview

The EGit Mylyn GitHub connector supports creating task repositories for working with GitHub issues and Gists. A GitHub issue task repository is required for each GitHub project repository you want to access issues for. A single Gist repository allows you to access all Gists on http://gist.github.com.

The latest version of the EGit Mylyn GitHub connector can be installed from following update site:

http://download.eclipse.org/egit/github/updates-nightly

[edit] Getting Started

The Mylyn GitHub connector supports bulk adding all your GitHub repositories to the Mylyn Task Repositorities view.

  1. Select File > Import...
  2. Select the GitHub Task Repositories node under the Tasks category
  3. Select Next
  4. Enter your GitHub login name and password on the credentials wizard page
  5. Select Next
  6. Check all the GitHub repositories that you want to access issues from.
  7. Select Finish
  8. Open the Task Repositories view to browse the newly added task repositories and add queries or create new tasks.

[edit] Issues

[edit] Queries

GitHub issue task repositories support creating queries that filter by the following fields:

  • State (open or closed)
  • Milestones
  • Mentions
  • Assignee
  • Labels

Note that when multiple filters are used in the same query the returned issues will match all of the filters. The minimum required for a valid query is at least one status selected and a non-empty title.

GitHubMylynIssueQueryPage.png

[edit] Issue Editor

The GitHub issue task editor supports the following:

  • Editing the title & description
  • Adding a new comment
  • Closing & reopening the issue from the Actions section
  • Assigning the issue to someone from the People section
  • Adding and removing labels from the Attributes section
  • Updating the milestone from the Attributes section
GitHubMylynIssueEditor.png

[edit] Gists

[edit] Creating

Gists can be created by selecting text in a editor or files in an explorer and selecting either the GitHub > Create Private Gist or GitHub > Create Public Gist context menu. The Gist will be created in a background job and a notification popup will display with a link to open the newly created Gist.

[edit] Queries

Gist queries only support filtering by a specified GitHub login name.

[edit] Gist Editor

The task editor for Gists supports the following:

  • Editing the description
  • Adding a new comment
  • Opening the files in a gist in an editor
  • Adding new files to the gist
  • Replacing the content of a file currently in the gist
  • Cloning the gist to a local Eclipse project
GitHubMylynGistEditor.png

[edit] Frequently Asked Questions (FAQ)

  • Does the connector support GitHub API tokens?
    • No, API tokens are no longer supported by the GitHub v3 API which the connector uses for requests.
  • Are GitHub API requests made over HTTPS?
    • Yes, all requests made through the GitHub API are over HTTPS.