Jump to: navigation, search

Difference between revisions of "Orion/How Tos/Working with git"

< Orion‎ | How Tos
(Linking to a git clone already existing on your computer)
(category sort)
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
= Linking to a git clone already existing on your computer  =
+
= Linking to a Git clone already existing on your computer  =
# First [http://www.kernel.org/pub/software/scm/git/docs/git-clone.html clone] a git repository to any location in your local filesystem, you can do with a tool of your choice ([[EGit]], [http://code.google.com/p/msysgit/downloads/list msysgit]...)
+
# [[Orion/How_Tos/Install_Orion_on_Localhost#Downloading_and_Running_Orion_on_Localhost|Download and run Orion]]
+
# Create a project and [[Orion/How_Tos/Install_Orion_on_Localhost#Linking_to_existing_content|link it]] to the location you used in Step 1. Link using '''file''' in the checkbox, not gitfs, which [https://bugs.eclipse.org/bugs/show_bug.cgi?id=338215 be soon gone].
+
# Orion will automatically detect that the project is actually a git clone (we will probably make it configurable in the future)
+
  
= Linking to a git repository using git file store =
+
#First [http://www.kernel.org/pub/software/scm/git/docs/git-clone.html clone] a git repository to any location in your local filesystem, you can do with a tool of your choice ([[EGit]], [http://code.google.com/p/msysgit/downloads/list msysgit]...)
 +
#[[Orion/How Tos/Install Orion on Localhost#Downloading_and_Running_Orion_on_Localhost|Download and run Orion]]
 +
#Create a project and [[Orion/How Tos/Install Orion on Localhost#Linking_to_existing_content|link it]] to the location you used in Step 1.
 +
#Orion will automatically detect that the project is actually a Git clone (we will probably make it configurable in the future)
  
{{warning|Work in progress|This scenario has not been fully implemented yet.}}
+
= Cloning a Git repository  =
  
# [[Orion/How_Tos/Install_Orion_on_Localhost#Downloading_and_Running_Orion_on_Localhost|Download and run Orion]]
+
{{warning|Work in progress|This scenario has not been fully implemented yet.}}
# Make sure <code>org.eclipse.orion.server.filesystem.git</code> is added your launch configuration
+
 
# When [[Orion/How_Tos/Install_Orion_on_Localhost#Linking_to_existing_content|linking]] a project select <code>gitfs</code>, enter URL for a git repository and leave Module empty
+
For detailed instruction how to clone repository from GitHub view [[Orion/How Tos/Cloning repository from github]]
# If you entered an existing location on your computer it must be a cloned repository, we won't be doing any smart detection here<br>[[Image:Howtogit--link folder dialog2.png]]
+
 
# For a git repository which requires authentication (e.g. starts with ssh://) to be able to clone it (and also fetch and push) you will need to wait for [https://bugs.eclipse.org/bugs/show_bug.cgi?id=334120 bug 334120] to be fixed<br>[[Image:Howtogit--link folder dialog.png]]
+
#[[Orion/How Tos/Install Orion on Localhost#Downloading_and_Running_Orion_on_Localhost|Download and run Orion]]  
# Under the hood, a git implementation of EFS will be used to clone the repository pointed by the URL. The file store's only role is to clone the repo. Modifying the working tree can be accomplish with the [[Orion/Server_API/File_API|File API]]. Adding files to the index, committing them and other git operations will be available via the [[#Git REST API|Git REST API]].
+
#Click the '''Repositories''' link to go to the Git Clones viewer.<br><br>[[Image:Orion Repostories link.png‎]]<br><br>
 +
#Select the Git Clone action.<br><br>[[Image:Git clone action.png]]<br><br>  
 +
#Enter the Git repository URL, and click '''OK'''.<br><br>[[Image:Clone_git_repository_dialog.png]]<br><br>
 +
#The repository will be cloned to a default location in your workspace. If you want to change target location click "Choose target location" and input the new project name or select a directory that already exists in your workspace.<br><br>[[Image:Clone_git_repository_dialog_advanced.png]]
 +
#If authentication is needed you will be prompted for credentials. Which fields are required depends on the specific repository you're connecting to.<br><br>[[Image:Git clone dialog.png]]<br><br>
 +
#When cloning is finished, you'll see the new clone appear in the list:<br><br>[[Image:Git_clone_complete.png]]<br><br>
 +
#Done! You may use the Repositories view to browse remotes and branches of your repository or click the main repository link to view repository contents.<br><br>[[Image:Git_clone_repo_view.png]]<br>
  
 
= Using Orion Compare Viewer =
 
= Using Orion Compare Viewer =
Line 32: Line 37:
 
  http://Your_server:8080/js/compare/demo/demo.html#/file/your_project/your_file
 
  http://Your_server:8080/js/compare/demo/demo.html#/file/your_project/your_file
 
  ( e.g.  http://localhost:8080/js/compare/demo/demo.html#/file/K/bundles/org.eclipse.orion.client.core/static/js/compare/demo/demo-inline.html)<br>[[Image:Howtogit--side-by-side-viewer1.png]]
 
  ( e.g.  http://localhost:8080/js/compare/demo/demo.html#/file/K/bundles/org.eclipse.orion.client.core/static/js/compare/demo/demo-inline.html)<br>[[Image:Howtogit--side-by-side-viewer1.png]]
 +
 +
= Using Orion Git Status Page =
 +
{{warning|Work in progress|This scenario has not been fully implemented yet.}}
 +
Please note that the section is currently used for developer's discussion.The UI shown below is the developer's UI mockup. The functionality is addressed in a high level.
 +
 +
[[Image:Howtogit--git-status_new.png]]
 +
# Similiar to the compare viewer , the URL format of the git status page is : http://localhost:8080/git-status.html#/file/K/bundles/org.eclipse.orion.client.core/static/js/compare/.<br>Here you pass the directory path to the html.The page will show you the git status under that directory.
 +
# There will be an action somewhere in the navigator to open this page so that user does not have to input the directory as the hash.
 +
# On the left hand , all the unstaged and staged changes are listed up in two areas.
 +
# Clicking on any line will high-light it and the right hand side viewer will show the difference of that file against the Git repo.
 +
# On the unstaged area , hovering on any line pops up two action buttons : compare and stage. The compare action navigates user to a side by side compare viewer. The stage action will stage the file represented by the line.
 +
# On the staged area , hovering on any line pops up two action buttons : compare and unstage. The compare action navigates user to a side by side compare viewer. The unstage action will unstage the file represented by the line.
 +
# The side by side viewer is planned to be upgraded to a compare merge editor post M6.
  
 
= Git REST API =
 
= Git REST API =
Line 41: Line 59:
  
  
[[Category:Orion]] [[Category:Orion/How_To]]
+
[[Category:Orion|How To]]
 +
[[Category:Orion/How_To|Git]]

Latest revision as of 13:20, 23 June 2011

Linking to a Git clone already existing on your computer

  1. First clone a git repository to any location in your local filesystem, you can do with a tool of your choice (EGit, msysgit...)
  2. Download and run Orion
  3. Create a project and link it to the location you used in Step 1.
  4. Orion will automatically detect that the project is actually a Git clone (we will probably make it configurable in the future)

Cloning a Git repository

Warning2.png
Work in progress
This scenario has not been fully implemented yet.


For detailed instruction how to clone repository from GitHub view Orion/How Tos/Cloning repository from github

  1. Download and run Orion
  2. Click the Repositories link to go to the Git Clones viewer.

    Orion Repostories link.png

  3. Select the Git Clone action.

    Git clone action.png

  4. Enter the Git repository URL, and click OK.

    Clone git repository dialog.png

  5. The repository will be cloned to a default location in your workspace. If you want to change target location click "Choose target location" and input the new project name or select a directory that already exists in your workspace.

    Clone git repository dialog advanced.png
  6. If authentication is needed you will be prompted for credentials. Which fields are required depends on the specific repository you're connecting to.

    Git clone dialog.png

  7. When cloning is finished, you'll see the new clone appear in the list:

    Git clone complete.png

  8. Done! You may use the Repositories view to browse remotes and branches of your repository or click the main repository link to view repository contents.

    Git clone repo view.png

Using Orion Compare Viewer

Warning2.png
Work in progress
This scenario has not been fully implemented yet.

Although still in progress , you can now use both in-line and side-by-side compare viewer from Orion.Currently you have to use the viewer HTML directly in your browser and use your file location as the hash of the html. Please also note that the compare viewer container UI will be changed later to fit better layout.

  1. Download and run Orion or pull the latest code on both server and client side.
  2. Link a folder to your git repository.
  3. Open a file in the folder by Orion Editor.
  4. Change something and save the changes.
  5. Copy the "#/file/your_project/your_file" part from the editor URL as the file location.
  6. Paste it as the hash value of the viewer HTML(/js/compare/demo/demo-inline.html and /js/compare/demo/demo.html)
  7. Below are the format and examples.
  • In-line viewer :
http://Your_server:8080/js/compare/demo/demo-inline.html#/file/your_project/your_file
( e.g.  http://localhost:8080/js/compare/demo/demo-inline.html#/file/K/bundles/org.eclipse.orion.client.core/static/js/compare/demo/demo-inline.html)
Howtogit--in-line-viewer.png
  • Side-by-side viewer(as planned , this viewer will become the merge editor):
http://Your_server:8080/js/compare/demo/demo.html#/file/your_project/your_file
( e.g.  http://localhost:8080/js/compare/demo/demo.html#/file/K/bundles/org.eclipse.orion.client.core/static/js/compare/demo/demo-inline.html)
Howtogit--side-by-side-viewer1.png

Using Orion Git Status Page

Warning2.png
Work in progress
This scenario has not been fully implemented yet.

Please note that the section is currently used for developer's discussion.The UI shown below is the developer's UI mockup. The functionality is addressed in a high level.

Howtogit--git-status new.png

  1. Similiar to the compare viewer , the URL format of the git status page is : http://localhost:8080/git-status.html#/file/K/bundles/org.eclipse.orion.client.core/static/js/compare/.
    Here you pass the directory path to the html.The page will show you the git status under that directory.
  2. There will be an action somewhere in the navigator to open this page so that user does not have to input the directory as the hash.
  3. On the left hand , all the unstaged and staged changes are listed up in two areas.
  4. Clicking on any line will high-light it and the right hand side viewer will show the difference of that file against the Git repo.
  5. On the unstaged area , hovering on any line pops up two action buttons : compare and stage. The compare action navigates user to a side by side compare viewer. The stage action will stage the file represented by the line.
  6. On the staged area , hovering on any line pops up two action buttons : compare and unstage. The compare action navigates user to a side by side compare viewer. The unstage action will unstage the file represented by the line.
  7. The side by side viewer is planned to be upgraded to a compare merge editor post M6.

Git REST API

This section was moved to Orion/Server_API/Git_API.

Bugs, comments, feedback

If you experience any problems when following the steps above ping z4z4 or SzymonB on IRC (use #eclipse-orion channel), or open a new bug right away.