Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[stellation-res] Status Update: Transitional Client

The bulk of the work on the Stellation T-Client (Transitional Client)
has been completed.  Work is now underway on adding Sync/Merge
functionality to the T-Client, using the new TeamSubscriber and Sync APIs
provided as part of the Eclipse R3M7 milestone release (dated 2004-02-13).

A discussion of the T-Client features (and the motivation for creating it)
is available here:
http://stellation.eclipse.org/twiki/bin/view/Stellation/EclipseClient

This note provides a general overview of the Stellation T-Client and
a brief guide to its usage.  More information will be posted on the Wiki
around Friday Feburary 20th (I am on vacation for several days attending
to a family obligation).

Current features
· Configure Repository Access (database and server names, user name and password) · Share project (connect to repository, enable local Stellation project management)
· Unmanage project (restore independent, unmanaged project status)
· Check in changes as new revisions, with comments.
· Create new branches ("Fork"), specifying branch name and description
· Check out revisions from any branch
· Browse branches and revisions in the current project
· View status information about local workspace and most recent checkout
· See detailed status information for managed resources within local workspace.
· View a list of projects in a connected repository.

Basic tasks:

Share a Project
1)      Select Project in Navigator or Package Explorer
2)      Right-click to popup context menu
3)      Select Team > Share Project > Stellation CM, and click Next
4) Select the desired repository. To configure access for a new repository, see instructions below 5) Select 'Use Eclipse Project Name' (usually recommended), or click radio button and specify a different Project name. In this case, the 'Project Name' is the name of the project contained within the Stellation repository.
6)      Click Finish.

The T-Client will now connect to the repository, create the project in the repository if necessary, and then create a 'personal branch' for individual development work. The default name of the personal branch is {username}-sandbox, but you can change this in the Window > Preferences > Stellation if necessary.

Configure Repository Access
(At present, you can only do this from within the Share Project wizard).
1)      Run the Share Project wizard on an unshared project as described above.
2)      Click the Configure Access: More .... button
3)      Click the 'Add' button
4) Specify an alias (nickname or friendly name) for this repository 'access' 5) Specify the name of the database (i.e. 'stellationdb') and the name of the server (i.e. 'stellation.eclipse.org') 6) Enter your username and password (the password is encrypted and stored using standard Eclipse mechanisms for sensitive data).
7)      Click 'Test' to verify that you can access the repository.

Note: Once a Repository Access is configured, you can view a list of all projects in the repository by selecting the Access alias (in the list of Repository aliases
displayed in step 2) above) and clicking the 'View Contents' button.

Check in a new Project-level Revision (includes all changes to your local workspace)
1)      Select Project in Navigator or Package Explorer
2)      Right-click to popup context menu
3)      Select Team > Checkin
4)      Enter a comment describing the changes, and click OK

The project is checked in and automatically checked out again, to ensure the repository and your local workspace are fully in sync.

Create a new Branch
1)      Select Project in Navigator or Package Explorer
2)      Right-click to popup context menu
3)      Select Team > Fork
4) Enter a name for the new branch. This name is checked against existing branches; a message is displayed if the name is non-unique, and you will be prompted to enter a different name. Click OK to proceed. 5) Enter a description of the new branch. This description will appear in Revision selection (or browsing) dialogs.
6)      Click OK to proceed and create a new branch.

Note: the newly-created branch is populated with artifacts from the base revision of the local working image. If you have made any changes since your last checkout, these changes are not automatically checked in when you create a new branch. After creating a new branch, you may do a checkin as described above to save any changes to the new branch.

Checkout a Revision
1)      Select Project in Navigator or Package Explorer
2)      Right-click to popup context menu
3) Select Team > Checkout Revision. If the local workspace has been changed since your last checkout, you will be asked whether you want to continue (to avoid accidental deletion of local changes). 4) The Checkout Revision dialog appears. This is a two-level tree dialog listing branches and their revisions. Information about the currently-selected branch appears in the lower pane. 5) Select the desired Revision, and either double-click it or click the OK button.

The selected revision will be checked out into your local workspace. Please note: this will delete any Stellation-managed resources in your workspace which are not part of the checked-out revision.

Browse information about your local workspace.
1)      Select Project in Navigator or Package Explorer
2)      Right-click to popup context menu
3)      Select Team > Project Info

The Stellation Project Resources dialog appears. This lists the current branch and base version, the time of the last checkout, the repository alias. and whether or not the workspace has been modified since the last checkout. It also lists various statistics about the number of managed resources, the number of new, modified, renamed/moved and deleted files, the total number of managed files, and the total number of managed folders. You may also: · Click the 'List Versions' button to view the branches and revisions for the project. This dialog is basically the same as the Checkout Revision dialog (except that you cannot checkout a revision in this context). · Click the 'View Resources' button to view the list of managed file resources in your local workspace. The Project Resources dialog lists the name, project-relative path and status (New / Edited / Moved) for all managed resources in the current project. You may click on any header tab to resort the list by the selected value (i.e. to group all modified resources together).

Unmanage a Project
(This removes the local project from management by Stellation)
1)      Select Project in Navigator or Package Explorer
2)      Right-click to popup context menu
3) Select Team > Unmanage. You will be prompted to confirm that you want to unmanage this project.

Regards,

Jim


--------------------------------------------------------------------
Jim Wright, IBM T.J. Watson Research Center
*** The Stellation project: Advanced SCM for Collaboration
*** http://www.eclipse.org/stellation
*** Work Email: jwright@xxxxxxxxxxxxxx ------- Personal Email: jim.wright@xxxxxxx



Back to the top