2008-06-26T00:17:02Z

Updated ssh URL for subversion 4 SourceControl 93

[[Home | » Project Kenai Documentation and Training]]     [[Howdoi | » How Do I ...]] <h1>Source Code Management</h1> When a project administrator chooses a Subversion, Mercurial, or Git repository for your project, as described at [[ManageProject#Source_Code_Repository|Managing a Project: Source Code Repository]], a source code management repository is set up and hosted here that works with this site's Subversion, Mercurial, or Git server software. '''''Note:''''' ''If your project uses an external repository, none of the information on this page applies.'' For example, for a project named ''bluebird'' with a subversion repository named ''subversion'', here's the URL for https access: <nowiki>https://kenai.com/svn/bluebird~subversion</nowiki> Here's the URL for SSH access: <tt><nowiki>svn+ssh://</nowiki></tt>''your-username''<tt>@svn.kenai.com/bluebird~subversion</tt> Here's where the read-only Mercurial repository would be: <nowiki>https://kenai.com/hg/bluebird~mercurial</nowiki> For read/write access to your Mercurial repository, use the Secure Shell Protocol, or SSH, and the ssh prefix. For example: <nowiki>ssh://</nowiki>''your-user-name''<nowiki>@hg.kenai.com/bluebird~mercurial</nowiki> Here's where the read-only Git repository would be: <nowiki>git://kenai.com/bluebird~git-code-repository</nowiki> '''Note:''' The git prefix uses a custom service called ''git-daemon'' to provide read-only public access to repositories. For read/write access, you must use the Secure Shell Protocol, or SSH, and the ssh prefix. For example <tt><nowiki>ssh://</nowiki>''your-user-name''<nowiki>@git.kenai.com/bluebird~git-code-repository</nowiki></tt> To check files out of and into one of these repositories, you have to install the corresponding client software on your local machine, as described below in [[#overview|Overview: Checking Files Into and Out of a Repository]]. '''Note:''' The project administrator can add more repositories to a project on its Manage page. (On the project's home page, click Manage This Project.) See [[ManageProject#Source_Code_Repository|Managing a Project: Source Code Repository]] for more information. __TOC__ ==Viewing Source Repository Information== To see where your project's source code repository is, open the project page and click the repository link on the left under Source Code Repository. [[image:selectrepos.png]] ==Overview: Checking Files Into and Out of a Repository== To check files into and out of the repository, you have to download the [[#About_Subversion|Subversion client]], the [[#About_Mercurial|Mercurial client]], or the [[#About_Git|Git client]] and install it on your local system. In general, here's what you do for Subversion to initially get your code into your repository: # Install the corresponding source code management client on your local system. # Create a directory on your local machine for the local repository. # Check out the empty repository from the server to your local repository. # Add directories and files to the local repository. # Check the files into your repository on the server. For Mercurial and Git, the process is a little different: # Set up an [[GeneratingAnSSHKey|SSH key pair]] and add the public key to your user profile. # Create a local working repository. # Add your kenai.com repository as a remote repository, using the ssh syntax. # In your local working repository, create or import the source code to be checked in. # Mark the new files to be added. # Commit the new files to the local repository. # Push the changes to your kenai.com repository. After you have some code in the repository, you can use your browser to view the code. See <a href="#browsing">Browsing Source Repositories</a> below for more information. ==About Subversion== Subversion is a centralized version control system initially designed to be a suitable replacement for the Concurrent Versions System (CVS). It has long since surpassed CVS in functionality and extensibility. It's available for free either as source code that you compile or as a binary package that's ready to install. See [http://subversion.tigris.org] for more information on getting the Subversion client and installing it on your local system. ===Accessing a Subversion Repository=== Once you have Subversion installed on your local system, you can check out code and check it back into your project repository. The following instructions should get you started. * [[Usingsvn-unixmac|Using Subversion on UNIX and Mac Systems]] * [[Usingsvn-win|Using Subversion on Microsoft Windows Systems]] For full instructions on using Subversion, see [http://svnbook.red-bean.com/]. ==About Mercurial== Mercurial is a distributed revision control system that is designed to be fast and lightweight. It has a command structure similar to Subversion's. You can download the Mercurial client for installation on your local machine either as a [http://www.selenic.com/mercurial/wiki/index.cgi/BinaryPackages binary package] or as [http://www.selenic.com/mercurial/wiki/index.cgi/Download source code] that you build yourself. ===Accessing a Mercurial Repository=== Once you have Mercurial installed on your local system, you can check out code and check it back into your project repository. The following instructions should get you started. * [[Usinghg-unixmac|Using Mercurial on UNIX and Mac Systems]] * [[Usinghg-win|Using Mercurial on Microsoft Windows Systems]] For full instructions on using Mercurial, see [http://hgbook.red-bean.com/]. ==About Git== Git is a distributed revision control system that was originally built for use by the Linux kernel developers. Its feature set is similar to that of Mercurial, with the addition of fast local branching. Like Subversion, it is available as open source for most popular operating systems. You can download the Git client at [http://git-scm.com/download]. ===Accessing a Git Repository=== Once you have Git installed on your local system, you can check out code and check it back into your project repository. The following instructions should get you started. # Before you can work with Git, you need to add a public SSH key to your site profile as described in [[GeneratingAnSSHKey|Generating An SSH Key]]. # Open your Kenai project's Git repository page (as described above under [[#Viewing_Source_Repository_Information|Viewing Source Repository Information]]) and copy the SSH URL to your clipboard. # On your local system, open a terminal window on Linux or Mac or run the Git program on Windows, which opens a Git terminal window for you. # In your terminal window, run the following series of commands to create a new repository directory, initialize a local repository in that directory, and connect the Kenai server repository to it: <tt>mkdir new-repo</tt> <tt>cd new-repo/</tt> <tt>git init</tt> <tt>git remote add origin <nowiki>ssh://</nowiki>''your-user-name''<nowiki>@git.kenai.com/</nowiki>''your-project-name''<nowiki>~git-code-repository</nowiki></tt> '''Note:''' You need to paste in your own ssh path to the last command above. After this series of steps, you can use the local Git repository to check code in and out and push and pull revisions to and from the remote Kenai repository. For example, you can create a local file called <tt>hello.txt</tt> and add and commit it to your local repository, then push the changes to your project's Kenai repository by using the following sequence of commands in a terminal or Git window: $ git add hello.txt $ git commit hello.txt -m"First commit of new file hello.txt" $ git push origin master After a successful push, the changes are reflected in the source code browser for your project on Kenai.com. Any other clones of the repository will be able to see them as well after you <tt>git</tt> <tt>pull</tt> the latest revision. ==Browsing Source Repositories== Project Kenai not only enables you to do source code management, but lets you browse your repositories with your web browser. To browse a project's repository, you first display the project page, then click Get Source Code and click Browse in the popup, as shown below. '''Note:''' You can limit who can browse your source code by setting role permissions for the ''Check Out'' action. For more information, see [[ManageProject#Source_Code_Repository|Managing a Project: Source Code Repository]]. [[image:browsecoderepos.png]] {|- |       |'''Note:''' ''If you see a screen like the following one, the repository is empty. Follow the instructions [[#overview|above]] for your type of source control management system to add files to the repository.'' [[image:browserepos-nofiles.png]] |       |} After clicking Browse, you see a list of the project's repository's files and folders. Click files to see them or click folders to open them. You can use the dark blue path (below the light blue area that shows the revision number) to keep track of where you are in the tree. You can click any folder in that path to navigate back up the tree. For example, the following screen shot shows the createPkg1.html file open in the sourceUI folder. The path is above ''File Revision History''. [[image:browserepos-viewfile.png]] With a file displayed, here are some of the things you can do: ===Determining the File Revision Number=== You see the revision number at the top left of the light blue region. In the image above, the revision number is 34. ===Seeing File Revision History=== Click ''File Revision History'' on the left under the path and above the file size. (See above figure.) ===Getting a Copy of the File=== To get a copy of the file that you can save on your local machine: # Click ''Get Raw File'' to the right of ''File Revision History''. (See above figure.) # In the browser dialog box, save the file. ===Viewing Diffs of Two File Revisions=== A ''diff'' is a view of both files showing the changes (differences). To see a diff between two revisions: # Display the file and click ''File Revision History'' to determine which revisions you want to see. [[image:browserepos-filerev.png]] # Click the browser's Back button to go back to the previous screen that shows the file. # In the fields to the right of the ''Get diffs'' button, enter the two revision numbers you want to compare, then click ''Get diffs'', as shown in the figure below. [[image:browserepos-getdiffs.png]] ===Seeing Project Revision History=== Click ''Project Revision History'' in the top right part of the blue area. (See above figure.) ===Getting a File's Checkout URL=== # Click ''Checkout URL'' in the right part of the blue area under Project Revision History. # Select and copy the URL from the popup and use it in your source control client, as shown in the following figure. [[image:browserepos-checkouturl.png]]

<a href='<?url_for_page Home ?>' class='<?class_for_page_link Home ?>'> » Project Kenai Documentation and Training</a>     <a href='<?url_for_page Howdoi ?>' class='<?class_for_page_link Howdoi ?>'> » How Do I ...</a> <h1>Source Code Management</h1> When a project administrator chooses a Subversion, Mercurial, or Git repository for your project, as described at <a href='<?url_for_page ManageProject?>#Source_Code_Repository' class='<?class_for_page_link ManageProject?>'>Managing a Project: Source Code Repository</a>, a source code management repository is set up and hosted here that works with this site's Subversion, Mercurial, or Git server software. Note: If your project uses an external repository, none of the information on this page applies. For example, for a project named bluebird with a subversion repository named subversion, here's the URL for https access: <pre> https://kenai.com/svn/bluebird~subversion </pre>Here's the URL for SSH access: <pre> <tt>svn+ssh://</tt>your-username<tt>@svn.kenai.com/bluebird~subversion</tt> </pre> Here's where the read-only Mercurial repository would be: <pre> https://kenai.com/hg/bluebird~mercurial </pre>For read/write access to your Mercurial repository, use the Secure Shell Protocol, or SSH, and the ssh prefix. For example: <pre> ssh://your-user-name@hg.kenai.com/bluebird~mercurial </pre> Here's where the read-only Git repository would be: <pre> git://kenai.com/bluebird~git-code-repository </pre>Note: The git prefix uses a custom service called git-daemon to provide read-only public access to repositories. For read/write access, you must use the Secure Shell Protocol, or SSH, and the ssh prefix. For example <pre> <tt>ssh://your-user-name@git.kenai.com/bluebird~git-code-repository</tt> </pre> To check files out of and into one of these repositories, you have to install the corresponding client software on your local machine, as described below in <a href='#overview' class='internal'>Overview: Checking Files Into and Out of a Repository</a>. Note: The project administrator can add more repositories to a project on its Manage page. (On the project's home page, click Manage This Project.) See <a href='<?url_for_page ManageProject?>#Source_Code_Repository' class='<?class_for_page_link ManageProject?>'>Managing a Project: Source Code Repository</a> for more information. <div id='toc' class='toc'> <div id='toctitle' class='toc-title'> Contents </div> <div id='toccontents' class='toc-contents'><ul><ul><li>1 <a href='#Viewing_Source_Repository_Information'>Viewing Source Repository Information</a></li> <li>2 <a href='#Overview:_Checking_Files_Into_and_Out_of_a_Repository'>Overview: Checking Files Into and Out of a Repository</a></li> <li>3 <a href='#About_Subversion'>About Subversion</a></li> <ul><li>3.1 <a href='#Accessing_a_Subversion_Repository'>Accessing a Subversion Repository</a></li> </ul><li>4 <a href='#About_Mercurial'>About Mercurial</a></li> <ul><li>4.1 <a href='#Accessing_a_Mercurial_Repository'>Accessing a Mercurial Repository</a></li> </ul><li>5 <a href='#About_Git'>About Git</a></li> <ul><li>5.1 <a href='#Accessing_a_Git_Repository'>Accessing a Git Repository</a></li> </ul><li>6 <a href='#Browsing_Source_Repositories'>Browsing Source Repositories</a></li> <ul><li>6.1 <a href='#Determining_the_File_Revision_Number'>Determining the File Revision Number</a></li> <li>6.2 <a href='#Seeing_File_Revision_History'>Seeing File Revision History</a></li> <li>6.3 <a href='#Getting_a_Copy_of_the_File'>Getting a Copy of the File</a></li> <li>6.4 <a href='#Viewing_Diffs_of_Two_File_Revisions'>Viewing Diffs of Two File Revisions</a></li> <li>6.5 <a href='#Seeing_Project_Revision_History'>Seeing Project Revision History</a></li> <li>6.6 <a href='#Getting_a_File_s_Checkout_URL'>Getting a File's Checkout URL</a></li> </ul></ul></ul></div> </div> <h2><a name='Viewing_Source_Repository_Information'></a>Viewing Source Repository Information</h2> To see where your project's source code repository is, open the project page and click the repository link on the left under Source Code Repository. <?link_for_image selectrepos.png?> <h2><a name='Overview:_Checking_Files_Into_and_Out_of_a_Repository'></a>Overview: Checking Files Into and Out of a Repository</h2> To check files into and out of the repository, you have to download the <a href='#About_Subversion' class='internal'>Subversion client</a>, the <a href='#About_Mercurial' class='internal'>Mercurial client</a>, or the <a href='#About_Git' class='internal'>Git client</a> and install it on your local system. In general, here's what you do for Subversion to initially get your code into your repository: <ol><li> Install the corresponding source code management client on your local system. </li><li> Create a directory on your local machine for the local repository. </li><li> Check out the empty repository from the server to your local repository. </li><li> Add directories and files to the local repository. </li><li> Check the files into your repository on the server. </li></ol> For Mercurial and Git, the process is a little different: <ol><li> Set up an <a href='<?url_for_page GeneratingAnSSHKey?>' class='<?class_for_page_link GeneratingAnSSHKey?>'>SSH key pair</a> and add the public key to your user profile. </li><li> Create a local working repository. </li><li> Add your kenai.com repository as a remote repository, using the ssh syntax. </li><li> In your local working repository, create or import the source code to be checked in. </li><li> Mark the new files to be added. </li><li> Commit the new files to the local repository. </li><li> Push the changes to your kenai.com repository. </li></ol> After you have some code in the repository, you can use your browser to view the code. See <a href="#browsing">Browsing Source Repositories</a> below for more information. <h2><a name='About_Subversion'></a>About Subversion</h2> Subversion is a centralized version control system initially designed to be a suitable replacement for the Concurrent Versions System (CVS). It has long since surpassed CVS in functionality and extensibility. It's available for free either as source code that you compile or as a binary package that's ready to install. See <a class='external' href="http://subversion.tigris.org">http://subversion.tigris.org</a> for more information on getting the Subversion client and installing it on your local system. <h3><a name='Accessing_a_Subversion_Repository'></a>Accessing a Subversion Repository</h3> Once you have Subversion installed on your local system, you can check out code and check it back into your project repository. The following instructions should get you started. <ul><li> <a href='<?url_for_page Usingsvn-unixmac?>' class='<?class_for_page_link Usingsvn-unixmac?>'>Using Subversion on UNIX and Mac Systems</a></li><li> <a href='<?url_for_page Usingsvn-win?>' class='<?class_for_page_link Usingsvn-win?>'>Using Subversion on Microsoft Windows Systems</a></li></ul> For full instructions on using Subversion, see <a class='external' href="http://svnbook.red-bean.com/">http://svnbook.red-bean.com/</a>. <h2><a name='About_Mercurial'></a>About Mercurial</h2> Mercurial is a distributed revision control system that is designed to be fast and lightweight. It has a command structure similar to Subversion's. You can download the Mercurial client for installation on your local machine either as a <a class='external' href="http://www.selenic.com/mercurial/wiki/index.cgi/BinaryPackages">binary package</a> or as <a class='external' href="http://www.selenic.com/mercurial/wiki/index.cgi/Download">source code</a> that you build yourself. <h3><a name='Accessing_a_Mercurial_Repository'></a>Accessing a Mercurial Repository</h3> Once you have Mercurial installed on your local system, you can check out code and check it back into your project repository. The following instructions should get you started. <ul><li> <a href='<?url_for_page Usinghg-unixmac?>' class='<?class_for_page_link Usinghg-unixmac?>'>Using Mercurial on UNIX and Mac Systems</a></li><li> <a href='<?url_for_page Usinghg-win?>' class='<?class_for_page_link Usinghg-win?>'>Using Mercurial on Microsoft Windows Systems</a></li></ul> For full instructions on using Mercurial, see <a class='external' href="http://hgbook.red-bean.com/">http://hgbook.red-bean.com/</a>. <h2><a name='About_Git'></a>About Git</h2> Git is a distributed revision control system that was originally built for use by the Linux kernel developers. Its feature set is similar to that of Mercurial, with the addition of fast local branching. Like Subversion, it is available as open source for most popular operating systems. You can download the Git client at <a class='external' href="http://git-scm.com/download">http://git-scm.com/download</a>. <h3><a name='Accessing_a_Git_Repository'></a>Accessing a Git Repository</h3> Once you have Git installed on your local system, you can check out code and check it back into your project repository. The following instructions should get you started. <ol><li> Before you can work with Git, you need to add a public SSH key to your site profile as described in <a href='<?url_for_page GeneratingAnSSHKey?>' class='<?class_for_page_link GeneratingAnSSHKey?>'>Generating An SSH Key</a>. </li><li> Open your Kenai project's Git repository page (as described above under <a href='#Viewing_Source_Repository_Information' class='internal'>Viewing Source Repository Information</a>) and copy the SSH URL to your clipboard. </li><li> On your local system, open a terminal window on Linux or Mac or run the Git program on Windows, which opens a Git terminal window for you. </li><li> In your terminal window, run the following series of commands to create a new repository directory, initialize a local repository in that directory, and connect the Kenai server repository to it: <tt>mkdir new-repo</tt> <tt>cd new-repo/</tt> <tt>git init</tt> <tt>git remote add origin ssh://your-user-name@git.kenai.com/your-project-name~git-code-repository</tt> Note: You need to paste in your own ssh path to the last command above. </li></ol> After this series of steps, you can use the local Git repository to check code in and out and push and pull revisions to and from the remote Kenai repository. For example, you can create a local file called <tt>hello.txt</tt> and add and commit it to your local repository, then push the changes to your project's Kenai repository by using the following sequence of commands in a terminal or Git window: <pre> $ git add hello.txt $ git commit hello.txt -m"First commit of new file hello.txt" $ git push origin master </pre> After a successful push, the changes are reflected in the source code browser for your project on Kenai.com. Any other clones of the repository will be able to see them as well after you <tt>git</tt> <tt>pull</tt> the latest revision. <h2><a name='Browsing_Source_Repositories'></a>Browsing Source Repositories</h2> Project Kenai not only enables you to do source code management, but lets you browse your repositories with your web browser. To browse a project's repository, you first display the project page, then click Get Source Code and click Browse in the popup, as shown below. Note: You can limit who can browse your source code by setting role permissions for the Check Out action. For more information, see <a href='<?url_for_page ManageProject?>#Source_Code_Repository' class='<?class_for_page_link ManageProject?>'>Managing a Project: Source Code Repository</a>. <?link_for_image browsecoderepos.png?> <div style="overflow-x: auto;"><div style="margin: 0px 2px 0px 2px;"> <table -><tr><td>       </td><td>Note: If you see a screen like the following one, the repository is empty. Follow the instructions <a href='#overview' class='internal'>above</a> for your type of source control management system to add files to the repository. <?link_for_image browserepos-nofiles.png?></td><td>      </td></tr> </table> </div></div> After clicking Browse, you see a list of the project's repository's files and folders. Click files to see them or click folders to open them. You can use the dark blue path (below the light blue area that shows the revision number) to keep track of where you are in the tree. You can click any folder in that path to navigate back up the tree. For example, the following screen shot shows the createPkg1.html file open in the sourceUI folder. The path is above File Revision History. <?link_for_image browserepos-viewfile.png?> With a file displayed, here are some of the things you can do: <h3><a name='Determining_the_File_Revision_Number'></a>Determining the File Revision Number</h3> You see the revision number at the top left of the light blue region. In the image above, the revision number is 34. <h3><a name='Seeing_File_Revision_History'></a>Seeing File Revision History</h3> Click File Revision History on the left under the path and above the file size. (See above figure.) <h3><a name='Getting_a_Copy_of_the_File'></a>Getting a Copy of the File</h3> To get a copy of the file that you can save on your local machine: <ol><li> Click Get Raw File to the right of File Revision History. (See above figure.) </li><li> In the browser dialog box, save the file. </li></ol> <h3><a name='Viewing_Diffs_of_Two_File_Revisions'></a>Viewing Diffs of Two File Revisions</h3> A diff is a view of both files showing the changes (differences). To see a diff between two revisions: <ol><li> Display the file and click File Revision History to determine which revisions you want to see. <?link_for_image browserepos-filerev.png?></li><li> Click the browser's Back button to go back to the previous screen that shows the file. </li><li> In the fields to the right of the Get diffs button, enter the two revision numbers you want to compare, then click Get diffs, as shown in the figure below. <?link_for_image browserepos-getdiffs.png?></li></ol> <h3><a name='Seeing_Project_Revision_History'></a>Seeing Project Revision History</h3> Click Project Revision History in the top right part of the blue area. (See above figure.) <h3><a name='Getting_a_File_s_Checkout_URL'></a>Getting a File's Checkout URL</h3> <ol><li> Click Checkout URL in the right part of the blue area under Project Revision History. </li><li> Select and copy the URL from the popup and use it in your source control client, as shown in the following figure. <?link_for_image browserepos-checkouturl.png?></li></ol>

2009-12-24T00:35:31Z