Diff for "Code/UploadingABranch"

Not logged in - Log In / Register

Differences between revisions 1 and 21 (spanning 20 versions)
Revision 1 as of 2008-09-05 14:46:23
Size: 3528
Comment: work in progress
Revision 21 as of 2009-12-29 06:37:05
Size: 2824
Editor: kralph
Comment: grammar, wording
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
'''DRAFT: this page is a work in progress. Please [[Feedback|seek further help]] or check the [[TitleIndex|wiki index]] for a complete page on this topic.''' ## page was renamed from Code/UploadingABranch/Draft
~-[[FrontPage|Launchpad Help]] > [[Code]] > Uploading a branch -~
Line 13: Line 14:
The easiest way to get your code on Launchpad is to push your branch using Bazaar. Alternatively, Launchpad can mirror a Bazaar branch that's hosted elsewhere on the internet or convert existing Subversion and CVS repositories into Bazaar branches. The easiest way to get your code on Launchpad is to push your branch using Bazaar. Alternatively, Launchpad can mirror a Bazaar branch that's hosted elsewhere on the internet or convert existing git, Subversion and CVS repositories into Bazaar branches.
Line 17: Line 18:
If you've already got a Bazaar branch on your local machine, getting that branch up to Launchpad couldn't be easier.

In your terminal, go to the branch directory and type:

{{{
bzr launchpad-login userid
bzr push lp:~userid/project-name/branch-name
}}}

Replace ''userid'' with your Launchpad id, ''project-name'' with the project's Launchpad id and then chose whichever branch name you want.

'''Tip:''' If you have multiple ssh keys, you need to tell Launchpad which key to use.

Edit your ~/.ssh/config file (if one doesn't exist simply create a new one) and add the following:

{{{
Host bazaar.launchpad.net
    IdentityFile ~/.ssh/your_launchpad_key
    User your-launchpad-user-name

}}}

Bazaar will now push your branch up to Launchpad. You can then view the branch on your own [[https://code.launchpad.net/people/+me|Launchpad branches page]] and also on the project's branches page.
Line 19: Line 43:
== Pushing subsequent changes to Launchpad ==
Line 20: Line 45:
You can use Launchpad to host Bazaar branches of your code and, optionally, associate them with projects. Now, when you work on your code, all you need to do is commit changes to your local branch using ``bzr commit -m "Commit message"``.
Line 22: Line 47:
Launchpad offers a directory of and hosting serivce for fraee software code. You only need to push your changes up to Launchpad when you want to make them public.
Line 24: Line 49:
Using Launchpad, you can host Bazaar branches of code and, optionally, associate them with projects. You can also make your code available through Launchpad by mirroring it from elsewhere on the internet or by asking Launchpad to import it into a Bazaar branch from a Subversion or CVS repository. = Mirroring a branch that's hosted elsewhere =
Line 26: Line 51:
If you prefer to host your branch elsewhere, but still want to make it available in Launchpad, you can ask Launchpad to mirror it.
Line 27: Line 53:
Setting up a branch mirror is similar to registering a hosted branch, except you supply the URL to your branch and Launchpad makes periodic copies.
Line 28: Line 55:
Use the first two paragraphs to summarise all the important points about this article. = Next steps =
Line 30: Line 57:
Tell the reader if this is the information they need as soon as possible. If you need to work on the same branch of code with a group of people, you can [[Code/TeamBranches|create a team branch]].
Line 32: Line 59:
= Instructional text =

Where appropriate, use step by step instructions:

'''Step 1:''' Give concise and unambiguous instructions.

'''Step 2:''' Try not to state the obvious, unless you're writing for a novice user.

{i} '''Note:''' Highlight important information with a note.

'''Step 3:''' Use a well cropped screen shot if it will help orient the reader. Don't let the screen shot replace instructional text: not everyone can see your screen shot. Don't worry about borders or annotation for small, cropped screen shots such as this.

{{attachment:screen-shot.png}}

{i} '''Warning:''' If you're about to tell the reader to delete or otherwise change something that would be hard to restore, warn them.


== Full screen shots ==

||<tablestyle="float:right; font-size: 0.8em; width:30%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">{{attachment:proj-announce.png}}||
||<style="text-align: center;">'''Describe the screen shot here'''||

Some screen shots will be better placed to the right of your text. As they're not placed directly below the text that they support, use a border and short description.

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam sagittis. Aliquam eros dui, scelerisque id, consequat in, accumsan vitae, pede. Suspendisse neque ligula, scelerisque ac, mattis ut, aliquam quis, odio.

Proin nunc nisi, fringilla ac, congue ac, luctus eu, lacus. Maecenas ac purus. Cras felis metus, ultricies non, euismod ac, accumsan eleifend, leo. Quisque imperdiet tempus tellus.

Ut euismod, diam nec adipiscing interdum, tortor orci fringilla nisi, vel blandit erat magna at nisi. Fusce hendrerit odio non metus. Mauris nisl massa, dapibus id, feugiat quis, blandit a, quam. Integer tincidunt feugiat nunc. Curabitur iaculis egestas elit. Nam imperdiet suscipit odio.
||<tablestyle="width: 100%;"> ~-[[Code/FindingAndDownloading|< Finding and downloading code]] -~ ||<style="text-align: right;"> ~- [[Code/TeamBranches|Team branches >]] -~ ||

Launchpad Help > Code > Uploading a branch

Overview

Just as it's easy to create your own Bazaar branch of code that's registered in Launchpad, you can also host your code on Launchpad. It's free and means that your code is:

  • available for anyone else to download and work with
  • publicly associated with the project it relates to
  • ready to take part in public merge requests and code review.

The easiest way to get your code on Launchpad is to push your branch using Bazaar. Alternatively, Launchpad can mirror a Bazaar branch that's hosted elsewhere on the internet or convert existing git, Subversion and CVS repositories into Bazaar branches.

Pushing your Bazaar branch to Launchpad

If you've already got a Bazaar branch on your local machine, getting that branch up to Launchpad couldn't be easier.

In your terminal, go to the branch directory and type:

bzr launchpad-login userid
bzr push lp:~userid/project-name/branch-name

Replace userid with your Launchpad id, project-name with the project's Launchpad id and then chose whichever branch name you want.

Tip: If you have multiple ssh keys, you need to tell Launchpad which key to use.

Edit your ~/.ssh/config file (if one doesn't exist simply create a new one) and add the following:

Host bazaar.launchpad.net
    IdentityFile ~/.ssh/your_launchpad_key
    User your-launchpad-user-name

Bazaar will now push your branch up to Launchpad. You can then view the branch on your own Launchpad branches page and also on the project's branches page.

Pushing subsequent changes to Launchpad

Now, when you work on your code, all you need to do is commit changes to your local branch using bzr commit -m "Commit message".

You only need to push your changes up to Launchpad when you want to make them public.

Mirroring a branch that's hosted elsewhere

If you prefer to host your branch elsewhere, but still want to make it available in Launchpad, you can ask Launchpad to mirror it.

Setting up a branch mirror is similar to registering a hosted branch, except you supply the URL to your branch and Launchpad makes periodic copies.

Next steps

If you need to work on the same branch of code with a group of people, you can create a team branch.

< Finding and downloading code

Team branches >

Code/UploadingABranch (last edited 2016-04-30 09:51:08 by cjwatson)