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.
Contents
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.
Installation
Install 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 http.proxy "proxy_url:proxy_port" (if you have a proxy)
- git config --global http.sslcainfo \bin/curl-ca-bundle.crt
- git config --global http.sslverify "false"
- git config --global http.postbuffer "524288000"
- git config --global core.autocrlf "false"
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...->Git->Projects from Git this opens the Import Projects from Git dialog
- Click on Add to add a git repository path
- Browse to the location of the local cloned git repositories
- Select the repository to import projects from
- Click Next
- From the Select a wizard and decide how to share the imported projects page, select the Share new projects interactively radio option in the Method for sharing projects after project creation group
- Click Next
- From the Import Projects page, click the Select All button to check all the projects
- Click Next
- From the Share Projects with Git page
- Click Finish to finish the import
OSEE Git Development Workflow
The OSEE Git repository contains the following main branches:
- master: origin/master is the main branch where HEAD always reflects a production ready state.
- build_dev: origin/build_dev is the main branch where HEAD always reflects a state with the latest delivered development changes for integration.
- build_int: origina/build_int is the main branch where HEAD always reflects a state with the latest changes from development that have been tested/built and ready for customer assurance testing. The integration branch reflects the last development changes that have been incorporated into a release candidate.
Developers wanting to incorporate a change for a specific build should make the change in that build's development branch (ex. 0.9.6_dev).
***Developers should not make changes on master or _int branches.***
Setup
- Create a directory for the git repository (example: c:\gitroot)
- cd into the local git directory
- Create a clone of the OSEE repository: git clone https://<commiterId>@git.eclipse.org/gitroot/osee/org.eclipse.osee.git
- cd into org.eclipse.osee folder (the local OSEE repository)
- Add credential information:
- git config user.email my_committer_email@address.com
- git config user.name "Committer Name"
Local Development
Note: Development should only be performed on a development branch (never commit to master, or *_int branches)
Track a development branch
Before starting development, we need to create a local tracking development branch. You only need to perform this step at the beginning of the development cycle.
To create a tracking development branch:
- git checkout 0.9.6_dev origin/0.9.6_dev.
Make Change
- Keep development branch up-to-date
- Switch to the target build development branch: git checkout 0.9.6_dev
- Update local development branch with remote changes before any changes are made: git pull
- Optionally, you can inspect the changes pulled in: git log
- Making Changes: When working on a change, you have the option of making the changes directly on the development branch or creating a local feature/bug branches to encapsulate the work.
- To create a local branch: git checkout -b [Bug|Feature|Refactor]_[ID]_description 0.9.6_dev
- Check state (index and working tree): git status
- Add a new untracked file: git add <file_path>
- Add all untracked and modified files: git add -A
- Commit a change - See comment conventions below: git commit -am "Comment"
- Rebase against the remote branch frequently to prevent branch from diverging:
- git fetch origin 0.9.6.dev
- git rebase origin/0.9.6.dev
Tip: Creating a local working branch allows for better grouping of related changes and easier task switching
Incorporate a Finished Working Branch Into Development Branch
- Rebase the development branch to ensure it has the latest changes
- git fetch origin 0.9.6.dev
- git rebase origin/0.9.6.dev
- Switch to development branch: git checkout 0.9.6_dev
- Merge work branch into development: git merge --no-ff <working_branch_name>
- Push Changes to Remote: git push origin 0.9.6_dev
- Once work has been pushed to remote you can delete your local development branch: git branch -d <working_branch_name>
Additional Git Commands
- Compare two branches: git diff branch1..branch2
- Sharing a local work branch with others
- Switch to working branch: git checkout <working_branch_name>
- Push working branch to remote: git push origin <working_branch_name>:refs/heads/<working_branch_name>
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.
Comment Conventions
A commit comment consists of the following written in present tense:
- a summary line short (50 chars or less) summary of changes made. Should use the following format: CHANGE_TYPE[ID]: Summary
- a newline - Always follow your summary with a newline.
- an (optional) details section: Should be wrapped to 72 columns (git command such as git log don't wrap).
Summary Change Types:
- Bug Fixes: Any change the fixes problems with the existing code. Tag=Bug
- Features: Any change that is new functionality. Tag=Feature
- Refactors: Changes that are done to improve code design/quality. Tag=Feature
Summary Change Type Identifiers:
- Bugzilla Number - change originated from a bugzilla item, therefore use the following format: bgz_12314
- Action HRID - change originated from an ATS action, therefore use the following format: ats_HRID
Examples:
- Summary Lines:
Refactor[ID]: Update copyright statements
Bug[ID]: Fix concurrency issue in artifact update
Feature[ID]: Added conflict detection
- Comment with Details:
Bug[ats_ABCDE]: Fix artifact copy/paste copying invalid attribute types
Artifact copy/paste code change to check attribute types before creating them in the copied artifact. Additional checks include:
- Change one
- Change two
- Change three
Git common configuration (in a file)
[core] repositoryformatversion = 0 filemode = false bare = false logallrefupdates = true symlinks = false ignorecase = true hideDotFiles = dotGitOnly autocrlf = false [http] sslverify = false postbuffer = 524288000 [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 cpnx = cherry-pick --no-commit -x rhh = reset --hard HEAD [user] name = Gallus Anonymus email = GallusAnonymus@your_email.com
You can save the following in a .git/config_file and load it in with:
git config --file -- .git/config_file
Git Resources
- Git Commands
- Git Conflicts/Merging
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
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