Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
OSEE/Workspace Setup
This guide describes how to set up an Eclipse workspace to develop OSEE.
Downloading and Configuring Eclipse
See the PDE Build Guide for information on how to download and configure Eclipse. The SVN PDE Build Extension plugin can be skipped.
SVN Checkout
Download and import the relevant (client or application server) OSEE Team Project Set file frrom https://dev.eclipse.org/svnroot/technology/org.eclipse.osee/trunk/plugins/org.eclipse.osee.support.config/projectSets/ into your workspace.
In Eclipse, open the SVN Repository perspective and check out https://dev.eclipse.org/svnroot/technology/org.eclipse.osee/trunk/. The username and password can be left blank for anonymous read-only access.
Configure a Development Runtime
Using an SVN client such as Subversive, check out into your Eclipse workspace all the projects from https://dev.eclipse.org/svnroot/technology/org.eclipse.osee/trunk/. When configuring this SVN repository leave the user name and password blank in order to get anonymous, read-only access.
- Follow the PostgreSQL installation instructions.
- Use the configuration /org.eclipse.osee.support.config/launchConfig/OSEE Demo Application Server [localhost].launch to run an OSEE application server
- Use the configuration /org.eclipse.osee.ats.config.demo/MasterTestSuite_DemoDbInit.launch to initialize an OSEE database
- Use the configuration /org.eclipse.osee.ats.config.demo/MasterTestSuite_DemoDbPopulate.launch to populate the database for demonstration purposes
- Use the configuration /org.eclipse.osee.support.config/launchConfig/OSEE Demo product [localhost].launch to run a local OSEE client
Working with Git
This guide explains how to set up a local OSEE source repository using Git. When you complete it, you will have an Eclipse workspace populated with the OSEE projects from your Git working directory, with full tool support from both the EGit plugin and the original command-line git.
Installing Git on Windows
- Download the full installer for the latest version of msysGit.
- Run the installer, using the default settings.
- Open Git Bash and run the following commands:
- git config --global user.email my_committer_email@address.com
- git config --global user.name "Committer Name"
- git config --global http.proxy "proxy_url:proxy_port" (if you have a proxy)
- git config --global http.sslcainfo \bin/curl-ca-bundle.crt
- Create a clone of the OSEE repository.
- git clone https://<commiterId>@git.eclipse.org/gitroot/osee/org.eclipse.osee.git
Installing EGit
Install the latest stable versions of EGit and JGit from this update site.
Setting up a workspace
- Create a new Eclipse workspace.
- File > Import... > Existing Projects into Workspace
- As the root directory, select the plugins folder in the OSEE repository.
- Select all projects.
- Do not copy the projects into the workspace.
- Finish the import.
Git common configuration (in a file)
[core] repositoryformatversion = 0 filemode = false bare = false logallrefupdates = true symlinks = false ignorecase = true hideDotFiles = dotGitOnly autocrlf = false [svn-remote "svn"] url = https://dev.eclipse.org/svnroot/technology/org.eclipse.osee fetch = trunk:refs/remotes/trunk branches = branches/*:refs/remotes/* tags = tags/*:refs/remotes/tags/* [apply] whitespace = fix [diff] renames = copy [merge] conflictstyle = diff3 [alias] s = status c = commit co = checkout lg = log --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative cpnx = cherry-pick --no-commit -x rhh = reset --hard HEAD #fixes launchers fl = checkout -- *launch [user] name = Gallus Anonymus email = GallusAnonymus@your_email.com [guitool "git stash pop"] cmd = git stash pop [guitool "git stash"] cmd = git stash [guitool "git svn rebase"] cmd = git svn rebase
You can save the following in a .git/config_file and load it in with:
git config --file -- .git/config_file
Connecting to the Git repository
- Highlight all of the projects just imported from the repository.
- Right click and select Team > Share Project... (not Share Projects..., which is provided by SVN)
- Select Git as the repository type; click Next.
- Highlight all the lines displayed in the combo box (Ctrl+A).
- Click Finish.
Git Commands
Stash |
git stash save <message> git stash list git stash show -p stash@{0} git stash drop stash@{0} git stash pop |
Changes |
git show --name-only HASH path git diff HASH |
Compare two commits |
git diff OLDHASH NEWHASH |
Undo |
git rebase -i HEAD~5 git reset --hard HEAD git reset --hard HEAD~3 git reset --hard <specific_commit_id> |
To replace with incoming file so you can re-make your changes (or abandon them):
git checkout --[theirs|our] <path>
- Git Log
View history for a given path even if it has been moved/renamed:
git log --follow [current path]
View current branch activity:
git log --name-only HASH git lg | head
Show full history even with removed commits
git reflog show [log-options] master
- Branching and Merging
git checkout -b newLocalBranchName existingBranch
i.e.
git checkout -b 91 remotes/MS_0_9_1_20100111
creates a local tracking branch called 91
Switch branches:
git checkout [master|94|...]
Merge onto current branch:
git merge branch
git rebase --continue
Generating individual patches (one per commit) to submit by email (or bug report):
git format-patch -o ../ trunk..HEAD
will export all commits made to current branch, from trunk to HEAD.
-o ../
will put them one level above in individual .patch files
Generate a big patch for your local changes, (good for backup)
git diff trunk HEAD -p > Z:/backup_date_time.patch
In this case Z:\ is mounted as a shared windows folder, so if you do not have faith in your local backup software, this could help you quickly restore your work.
Splitting commits
In case you have multiple, conceptually unrelated changes in a single commit you can split them by doing a regular rebase:
git rebase -i HASH_WHERE_TO_START_FROM
mark 'e' or 'edit' the commit you want to Edit/Split. When you get dropped back into the shell, issue:
git reset HEAD^
which effectively undoes that commit and leaves the modified files unstaged ProGit Book Chapter 6-4
Afterwards you can 'add' and 'commit' changes as appr. To resume rebase operation issue the simple:
git rebase --continue
to continue.
Conflicts
Git Resources
- GIT PRO BOOK
- Git Community Book
- Git Tips
- GIT Branches, RC, etc Workflow
- GIT Branching Model
- GIT for Eclipse Users
Locations of all OSEE bundles
Git org.eclipse.osee
- git: /org.eclipse.osee/features/*
- git: /org.eclipse.osee/plugins/*
- git: /org.eclipse.osee/releng/*
Orbit Release Engineering Bundles
host: dev.eclipse.org Repository path: /cvsroot/tools connection type: extssh
- org.eclipse.orbit/org.eclipse.orbit.build.feature.set1
- org.eclipse.orbit/org.eclipse.orbit.releng
SWT Nebula Bundles
host: dev.eclipse.org Repository path: /cvsroot/technology connection type: pserver user: anonymous
- /cvsroot/technology/org.eclipse.swt.nebula/org.eclipse.nebula.widgets.xviewer
OSEE Website
host: dev.eclipse.org Repository path: /cvsroot/org.eclipse connection type: extssh