Diff for "Code/UploadingABranch"

Not logged in - Log In / Register

Differences between revisions 1 and 7 (spanning 6 versions)
Revision 1 as of 2008-09-05 14:46:23
Size: 3528
Comment: work in progress
Revision 7 as of 2008-10-09 12:33:14
Size: 4721
Comment: fixed formatting
Deletions are marked like this. Additions are marked like this.
Line 17: Line 17:
<<Anchor(registering)>>
== Registering your branch in Launchpad ==
Line 18: Line 20:
First up, you need to tell Launchpad about your branch. Visit [[https://code.launchpad.net/people/+me/+addbranch|your branch registration page]] and follow the on-screen instructions.
Line 19: Line 22:
'''Note:''' if you haven't already, you should read our guide to [[Code/FindingAndDownloading|creating your own branch]].
Line 20: Line 24:
You can use Launchpad to host Bazaar branches of your code and, optionally, associate them with projects. You should leave most of the options on the branch registration page at their default setting, other than:
Line 22: Line 26:
Launchpad offers a directory of and hosting serivce for fraee software code.  * '''Project:''' choose whichever project your code is a branch of
 * '''Branch type:''' choose ''Hosted'' as you want to host your branch on Launchpad.
Line 24: Line 29:
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. Once you've clicked the ''Register branch'' button, you're ready to push your code up to Launchpad.
Line 26: Line 31:
'''Tip:''' you can also push your branch to Launchpad without first registering it. To do so, you need to use the ''lp:~your-username/project-name/branch-name'' format. For your first branch, you should probably follow this guide.
Line 27: Line 33:
<<Anchor(first-push)>>
== Making the first push ==
Line 28: Line 36:
Use the first two paragraphs to summarise all the important points about this article. ||<tablestyle="float:right; font-size: 0.8em; width:30%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">{{attachment:branch-update.png}}||
Line 30: Line 38:
Tell the reader if this is the information they need as soon as possible. Before you do anything else, you need to tell Launchpad who you are and then ask Bazaar to log into Launchpad using your account. If you haven't already, [[ourAccount/CreatingAnSSHKeyPair|register your SSH key with Launchpad]]. Next, open up a terminal and enter:
Line 32: Line 40:
= Instructional text = {{{
$ bzr launchpad-login your-id
}}}
Line 34: Line 44:
Where appropriate, use step by step instructions: Replace ```your-id``` with your Launchpad id - e.g. ''matthew.revell'' rather than your email address.
Line 36: Line 46:
'''Step 1:''' Give concise and unambiguous instructions. On your new branch's overview page, you'll see the Bazaar command you need to issue in order to push your branch up to Launchpad.
Line 38: Line 48:
'''Step 2:''' Try not to state the obvious, unless you're writing for a novice user. Open up a terminal and enter:
Line 40: Line 50:
{i} '''Note:''' Highlight important information with a note. {{{
$ bzr launchpad-login your-username
}}}
Line 42: Line 54:
'''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. '''Note:''' The username you need to use in place of ''your-username'' is your Launchpad username. This isn't the email address you use to log into Launchpad but is instead the final portion of the URL of [[https://launchpad.net/people/+me|your profile page]].
Line 44: Line 56:
{{attachment:screen-shot.png}} If your login is successful, Bazaar will give you no message.
Line 46: Line 58:
{i} '''Warning:''' If you're about to tell the reader to delete or otherwise change something that would be hard to restore, warn them. Now, copy the ''Update this branch:'' command from your branch's overview page and paste it in your terminal. Before hit ''Enter'', add ``--use-existing-dir`` to the command, so it looks something like this:
Line 48: Line 60:
{{{
$ bzr push lp:~your-username/project-name/branch-name --use-existing-dir
}}}
Line 49: Line 64:
== Full screen shots == '''Note:''' You only need to add ``use-existing-dir`` the first time that you push to a newly registered branch.
Line 51: Line 66:
||<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'''||
Bazaar will now push your up to Launchpad. Give it a minute or two, then refresh your branch's overview page and you'll see the branch's most recent commits, as well as information about the format of your branch. Your branch is now public and anyone can make their own copy; only you can push changes to it and other people will have to upload their own version, just as you've done.
Line 54: Line 68:
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. == Pushing subsequent changes to Launchpad ==
Line 56: Line 70:
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. 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 58: Line 72:
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. You only need to push your changes up to Launchpad when you want to make them public.
Line 60: Line 74:
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. = 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 make regular copies.

= Next steps =

If you need to work on the same branch of code with a group of people, you can [[Code/TeamBranches|create a team branch]].

DRAFT: this page is a work in progress. Please seek further help or check the wiki index for a complete page on this topic.

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 Subversion and CVS repositories into Bazaar branches.

Pushing your Bazaar branch to Launchpad

Registering your branch in Launchpad

First up, you need to tell Launchpad about your branch. Visit your branch registration page and follow the on-screen instructions.

Note: if you haven't already, you should read our guide to creating your own branch.

You should leave most of the options on the branch registration page at their default setting, other than:

  • Project: choose whichever project your code is a branch of

  • Branch type: choose Hosted as you want to host your branch on Launchpad.

Once you've clicked the Register branch button, you're ready to push your code up to Launchpad.

Tip: you can also push your branch to Launchpad without first registering it. To do so, you need to use the lp:~your-username/project-name/branch-name format. For your first branch, you should probably follow this guide.

Making the first push

branch-update.png

Before you do anything else, you need to tell Launchpad who you are and then ask Bazaar to log into Launchpad using your account. If you haven't already, register your SSH key with Launchpad. Next, open up a terminal and enter:

$ bzr launchpad-login your-id

Replace your-id with your Launchpad id - e.g. matthew.revell rather than your email address.

On your new branch's overview page, you'll see the Bazaar command you need to issue in order to push your branch up to Launchpad.

Open up a terminal and enter:

$ bzr launchpad-login your-username

Note: The username you need to use in place of your-username is your Launchpad username. This isn't the email address you use to log into Launchpad but is instead the final portion of the URL of your profile page.

If your login is successful, Bazaar will give you no message.

Now, copy the Update this branch: command from your branch's overview page and paste it in your terminal. Before hit Enter, add --use-existing-dir to the command, so it looks something like this:

$ bzr push lp:~your-username/project-name/branch-name --use-existing-dir

Note: You only need to add use-existing-dir the first time that you push to a newly registered branch.

Bazaar will now push your up to Launchpad. Give it a minute or two, then refresh your branch's overview page and you'll see the branch's most recent commits, as well as information about the format of your branch. Your branch is now public and anyone can make their own copy; only you can push changes to it and other people will have to upload their own version, just as you've done.

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 make regular 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.

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