Git Workshop by Clearvision

Version 11 (diff) (Feb 02 04:29 by aron.gombas) | 4 comments and attachments (Feb 01 11:10 by aron.gombas) | No child pages

more
- Menu is not available...

Tags: No tags associated yet.

All Tags...

Planned server maintenance: Every day at 20:00-21:00 GMT
Limited or no service will be available that time.

Members
	Members: 33 (14586)

	Administrators:
	- adam.berkes
	- aron.gombas
	- j.koppany
	- support

Intland Blog - Feed
	Webinar: How to optimize your software development processes with codeBeamer and Git/Mercurial Aug 25 10:58
	Intland Software joined the Eclipse Foundation Aug 10 07:54
	codeBeamer 5.5 is on the way Jul 14 08:06
	Webinar: Working with codeBeamer and JavaForge Jul 07 04:50
	Working on the beach with Eclipse, Mylyn and Mercurial Jun 11 05:53
	Intland at Eclipse Embedded Day Stuttgart 2010 Jun 07 03:39
	Webinar: Eclipse & Mercurial - how to use Mercurial from Eclipse Jun 02 07:18
	MercurialEclipse 1.6.0: Enterprise Codebases with Ease May 11 02:06
	codeBeamer Eclipse Studio: Collaborative workspaces can now go offline May 06 02:39
	Presentation: Integration of a Holistic Application Lifecycle Management Approach with ITIL V3 Mar 24 10:52

dzone.com: latest front page - Feed
dzone.com: fresh links for developers

	Top 3 Performance Problems in Custom Microsoft CRM Applications Today 17:54
	How to use JMS for Synchronous Communication Today 17:46
	7 Things About Java 7 (Video) Today 17:35
	Mongrel2 1.0 ready for your glorious consumption Today 16:22
	IT Salaries: Want to Earn More? Fire People Today 16:02
	Java Synchronization (Mutual Exclusion) Benchmark Today 16:02
	Daily Dose - Release Candidate for PostgreSQL 9.0 Today 16:01
	IDE 2.0: The Age of Intelligent IDEs Today 15:59
	Scala: SwingBuilder Essentials Today 15:59
	DateTime.Now in v4.0 Causes Dynamic Memory Allocations Today 15:31

[ properties ] [ hide ]

[ Show Navigation... ]

codeBeamer and Git Workshop

Workshop Instructions

On this wiki page you find the instructions for the various activities that will be covered in the Workshop. The instructions expect you to be working on a Ubuntu Linux desktop with git and firefox installed and accessing a pre-configured codeBeamer server. If using a different environment then the instructions will need to be amended accordingly.
For the sample files (Git dumpfile, Android issues CSV, etc.) please see the attachments of this wiki page.

All text in RED boxes like this will be instructions for you to follow

To help evaluate the tool we would like you to score each activity as you complete it based on the following criteria (based on the tool and not the instructions!) :

ease of accomplishing activity

speed of accomplishing activity

supporting features for activity

user interface

If you have any queries or comments, please contact us.

These instructions have been exported to PDF using the inbuilt pdf export to provide you with a paper copy.

Activity 1 - User Registration

Before you can work in codeBeamer it needs to know who you are. There are several ways in which this can be accomplished and you can choose the best for you depending upon your security policies or requirements.

Here we will have each user set up their own Accounts and register their own details.

In reality the log in will most likely be connected to a corporate exchange server so account registration will be automatic.

Open Firefox Web Browser on your desktop and connect to the codeBeamer URL

Under the login prompt - click the Register link

Your user name should match your account on your client desktop

Fill in your details as directed on the New Account page

Click Submit

Now you are logged in and can look at your private wiki page

This implementation is set to allow automatic registration - this can be restricted.

Communication and authentication with codeBeamer managed git repositories uses SSH keys. So we will now generate our keys for our new user and associate them with our CB account.

Open a terminal window on your desktop

Type the following commands using your own student id and accepting the default options.


[student#@ubuntu]$ ssh-keygen -C "student#" -t rsa 

Generating public/private rsa key pair.

Enter file in which to save the key (/home/student#/.ssh/id_rsa): 

Enter passphrase (empty for no passphrase): 

Enter same passphrase again: 

Your identification has been saved in /home/student#/.ssh/id_rsa.

Your public key has been saved in /home/student#/.ssh/id_rsa.pub.

The key fingerprint is:

5c:56:48:71:82:7a:1c:a0:15:5b:2f:ff:72:64:60:58 student#

Next action is to associate your newly created shh key with the codeBeamer account.

Run the following command: cat ~/.ssh/id_rsa.pub

Copy the entire output

Return to your codeBeamer

Now select the 'Account Info' tab

Select the 'Public Ssh Keys Admin' link

Paste the key from the terminal into the box

Save

Next tell git who you are:

Enter the following commands in the terminal using your student id:

 

git config --global user.name 'student#'

git config --global user.email 'email@address.com'

Activity 2 - Creating and Joining Project

For the purposes of this workshop each of you will create your own sandbox project.

Download the git.dmp attachment to this wiki page - this is a test can you do it on your own?

Select the 'Projects' tab

click on the 'New Project' link

change template project to workshop

name the project student# project

Add a description - feel free to use any wiki markup here. If you do, change the Description format to wiki

Change the category to Education

Click the 'Source Code >' button

Select Git

Select Create New Managed Repository

Click 'Browse' and navigate to the git.dmp file downloaded at the start

Click Finish

Explore your new project

Next step is to make your Project Public and to allow others to join it

Select the 'Admin' tab

Select the 'General' tab

Select the Public with Join approval - project administrator must approve Join requests

Click 'Save'

Return to the 'Projects' tab

Select 'Available Projects' link

Now request to join as many projects as you wish - points will be given for the best reasons!

ensure you also request to join the workshop project

Now lets find out who likes you !

It is possible to jump straight to the Join Requests from the entries here

Select 'My Start' tab

Look at the Project Join Requests Pending section

If you have a (0), then you are not popular and have no friends

If you have lots of friends wanting to be in your cool project you can now decide if they are worthy of joining.

Select the 'Members' tab

Select the 'Join Requests' tab

Now you can or the requests

We will now accept you to the main Workshop Project and Assign Roles

Activity 3 - Explore Project Wiki

Our Projects are now set up, so lets see what we can do with them.

First lets add some more information to our own Project Wiki and Personal Wiki.

You will not see anything until some issues are assigned to you

Select 'My Start'

Select Edit link

Add the following text to the Wiki Markup and Save


[{ServiceLayerDemoPlugin}]

Next lets add the tag cloud plugin to the Project sidebar.

You will need to add some tags to see anything

Select 'Projects'

Select your project Student# link

Select Edit from the sidebar

Add the following text to the Wiki Markup and Save


[{TagCloud}]

Activity 4 - Document Management

In most Project scenarios you want to be able to quickly and easily locate supporting documentation.

Lets have a look at the CB Document Manager.

Download the Requirements documentation tar file attached to this page

Select the 'Documents' tab

In the left hand Tree view select the Requirements directory

Select the New File link

Browse to the tar file

Tick the Unpack ZIP/TAR checkbox

Click Add button

Activity 5 - Sprint Planning

Here we will look at how trackers could support a basic SCRUM process.

Download the android-issues csv's attached to this wiki page

Select the 'Trackers' tab

Select the Product Backlog tracker

From the more link select import

Browse to the android-issues.csv

change the Field Separator to a comma

Click on the Next > button

Change Start Import at Row: to 2

Match up the fields as per the following table - all other fields should be - not available

Click on 'Next'

set the Account Mapping' to your user

Click on 'Next'

CB Field	Android Field

ID	not available

Summary	Summary

Description	ID

Priority	Priority

Status	Status

Owner	Owner

Type	Type

Hours	Estimated Hours

As the project owner you have full access to all aspects of the project, but in reality you would assign project roles to individuals and grant access and control functions based on those permissions.

We now have our Product Backlog, we can review what Issues will be in our Sprint.

In your Product Backlog Tracker

Click New link next to Tracker view selector

Enter Name as Priority Order

In Status box tick Not and select Closed

In 'Sorting' section set Order By to Priority

Click 'Save' Button

We have a 120 hour Sprint - so select enough Critical issues to fill the Sprint.

Tick the selection box for the issue for the Sprint

Select Move To form the More Actions drop down

Review your selection

Select your Project and the 'SPRINT' Tracker as the destination

Click the 'Move' Button

Use the Mass Edit feature to update the Version information to release SR-2.0

We now have the Sprint back log and can set up Reports and a Burn Down Chart to monitor.

Go to your Tracker summary page

Select Edit link

After Tracker summary add the following text and click 'Save'


[{ TimeSeriesChart title='Sprint BurnDown Chart'



Actual

* 6/16/2009, 120



Trend

* 6/16/2009, 120

* 6/17/2009, 112

* 6/18/2009, 104

* 6/19/2009, 96

* 6/22/2009, 88

* 6/23/2009, 80

* 6/24/2009, 72

* 6/25/2009, 64

* 6/26/2009, 56

* 6/29/2009, 48

* 6/30/2009, 40

* 7/01/2009, 32

* 7/02/2009, 24

* 7/03/2009, 16

* 7/04/2009, 8

* 7/05/2009, 0

}]

Activity 6 - Development

Lets go to work - lets create some low level tasks for the issues in our sprint backlog and then get the code and make our changes.

There are several ways to achieve this. You can create separate Task tracker items and associate to this Sprint issue or as we will show here you can create child issues from the Parent. - which is best depends on your own requirements

Go to your SPRINT tracker

Select an issue - note the Issue ID

From the tabbed section at bottom of screen slect the Children tab

Select the New Child link

This task will be to create a build script so enter appropriate details for this.

Assign the Task to yourself

1. Either - Select Edit on the issue

1. or Transition to move the issue into an open status

We now need to get our copy of the code so we can work on it.

On your Desktop open a terminal window

enter the following command


git clone codebeamer@ipaddress:your_repo_name ~/workspace/project_name

Next lets put our System Integrator hat on and set up the current build.

Go to the 'Forums' tab

Click New Forum Link

Create a forum called Builds then click the 'Add' button

Got to the 'Builds' tab

Select the New Build link

Name your build and give it a description

enter the full path to the build file /usr/CB-5.4/repository/git/[reponame]/trunk/build.xml

In the build Scheduler section tick the Synchronization option

Tick the Run this build after source commit - set the time to 1 minute

Set the build Notification section for success and error to your new Forum

Click 'Save'

Run the build by clicking on the build name

Check output, review build logs and look in the forum

Check the Document Management area for the built binaries

hmmm we don't want the binaries in the root of the Document system

Create a new directory called Builds

Add a comment to your child issue stating that the binaries should go to this new directory

Back to development we are now going to amend the build file as instructed.

On Desktop navigate to your repository

open the file /trunk/build.xml for editing

amend the CBRelease tasks to the following then commit via git using the issue ID at start of the message (i.e. #1258)


<CBRelease description="Jdiff Jar" file="jdiff.jar" todir="Builds" sccCommitMessage="built new jar" />

<CBRelease description="Jdiff Zip" file="jdiff-src.zip" todir="Builds" sccCommitMessage="built new zip" />


git add build.xml

git commit -m "#109 Amended Build.xml file"

This change is now in your local git repository but the codeBeamer repository knows nothing about it.

How access to the managed repository is controlled is down to what process you wish to implement. Here we are allowing push from the local repository. Access is controlled via the the codeBeamer SCM - Commit' permission which can be granted to project roles.

It could be that Access is forbidden and task is raised and sent to the System Integrator with the relevant url to allow them to pull the changes in.

From your git repository enter the following command:


git push

As the build should be set to automatically run after 1 minute, wait a while and then check the Builds to see if it has run successfully following your changes.

As with most aspects of codeBeamer your process will dictate how you accomplish certain tasks. For code review you can create separate Task issues, associate them with the main Sprint tracker Issue and assign them to reviewers, or you can just assign the main Issue directly.

Now return to Tracker task and you can see the SCM commit information associated to it.

Move to the 'Task' Tracker

Create a Review task and assign to another project member, set start and end dates to today.

In the task associate it with the original Sprint issue that you committed your code against

Now lets check your tasks to see if you have reviews

Navigate to your 'My Start' tab

Check the 'My Open Issues in...' section

Click on the number of Assigned to me issues to view the details

(If you haven't got any then assign an issue to yourself)

Click on the review issue to go to the details

Navigate to the Associated tab and follow the link to the main issue

here you can see the committed code and open a diff report to see the changes made.

Once satisfied, return to your review task and add review comments in the comments section

Re-assign the task to the originator.

Activity 7 - Release Code

The Code has been delivered back to the managed repository and built successfully.

The Binaries have been published to the document manager ready for pick up by the QA or review team.

You can track the movement of a Software Release via the CMDB

Navigate to the 'CMBD' tab

Select the Software Release category

Here we can see that SR-1.0, the first release, has been released.

Select SR-1.0

View the Related Issues for the release.

Now navigate to SR-2.0 and you will see your Sprint Issues associated

We will now create SR-3.0 in readiness for next release I'm sure you will manage without instructions

You can provide the CMDB issue ID in the commit message to associate directly with the CMDB item, as you would with normal trackers.

Activity 8 - Sprint Review - trackers / reports

We can set up reports to help with the Daily Sprint Meetings

Navigate to the 'Reports' Tab

Select New link

Select Tracker Issues

Select the Workshop project

Select the SPRINT tracker

Set the Last Modified criteria to Yesterday

Accept the defaults

click the 'Save and Execute' button

	This site is powered by codeBeamer.
	The Collaborative ALM Solution by Intland Software.
	– Bug/Feature request – FAQ –

Table of Contents