launchpad development|
Size: 1855
Comment:
|
Size: 4852
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| = Prerequisites = | = One-time set-up = |
| Line 9: | Line 9: |
| submit_branch = lp:~launchpad-pqm/launchpad/devel push_location = lp:~rockstar/launchpad/ |
submit_branch = /home/rockstar/Projects/launchpad/trunk push_location = bzr+ssh://bazaar.launchpad.net/~rockstar/launchpad/ |
| Line 12: | Line 12: |
| public_branch = bzr+ssh://bazaar.launchpad.net/~rockstar/launchpad/ public_branch:policy = appendpath submit_to = merge@code.launchpad.net [/home/rockstar/Projects/launchpad/trunk] public_branch = bzr+ssh://bazaar.launchpad.net/~launchpad-pqm/launchpad/devel |
|
| Line 14: | Line 21: |
| A few things to note: the branch locations are specified with with lp: (as opposed to the path lp: resolves to). Launchpad must know about the source branch from the merge proposal (meaning it has to be registered on Launchpad). If Launchpad doesn't know about the target branch, it will create a remote branch for it. | In bazaar.conf, add an entry to your aliases: {{{ [ALIASES] lpsend=send --no-bundle }}} |
| Line 16: | Line 27: |
| It's also recommended that you tell bazaar about your mail client in ~/.bazaar/bazaar.conf | = Client configuration = Due to bug [[https://bugs.edge.launchpad.net/bzr/+bug/291847 | #291847]], it is necessary to specify your mail client on Intrepid. Possible values include: evolution, kmail, thunderbird, emacsclient, mutt |
| Line 18: | Line 32: |
| If your client is not supported, you can use "editor". e.g. |
|
| Line 22: | Line 39: |
== Claws == Bazaar's support for Claws is via xdg-utils, which is broken in Intrepid (see above). However, there is a tiny plugin that will will provide direct support for Claws: {{{ cd ~/.bazaar/plugins bzr branch lp:~allenap/+junk/bzr-claws claws }}} Don't forget to set `mail_client = claws` too. This also fixes a small annoyance when using xdg-utils with Claws. If you ask xdg-email to attach a file to the email, Claws will pop up a modal dialog box to confirm that a file has indeed been attached. Direct support for Claws is present in bzr.dev, and will be released in bzr 1.11 |
|
| Line 28: | Line 61: |
| bzr send --no-bundles --mail-to merge@code.launchpad.net | bzr push; bzr lpsend |
| Line 31: | Line 64: |
| You'll want to specify --no-bundles so that bzr checks to make sure your public branch has all the revisions of your local branch. You can also tell bzr where to send emails in your ~/.bazaar/locations.conf Following along from the example above, the file snippet would read: | This will create a merge proposal and a diff and place them in your preferred email client to polish off and send to Launchpad. The body of your message will be used as the initial comment. This example uses the lpsend alias, to ensure you specify --no-bundle. If you forget to supply --no-bundle, bzr send will not verify that your public branch is up-to-date. (Bundle support for Launchpad is coming soon.) = Frequently Asked Questions = '''Question:''' How do I specify revisions to generate the diff from? '''Answer:'''When doing bzr submit, you may want to only generate a diff from a range of revisions. You can use -r parameter to specify the range, as below: |
| Line 34: | Line 76: |
| [/home/rockstar/Projects/launchpad/] submit_branch = lp:~launchpad-pqm/launchpad/devel push_location = lp:~rockstar/launchpad/ push_location:policy = appendpath submit_to = merge@code.launchpad.net }}} === Specifying revisions === When doing bzr submit, you may want to only generate a diff from a range of revisions. You can use -r parameter to specify the range, as below: {{{ bzr send -no-bundles --mail-to merge@code.launchpad.net -r 1234..1239 |
bzr lpsend -r 1234..1239 |
| Line 50: | Line 80: |
'''Question:''' Does this work with looms? '''Answer:''' Launchpad's Loom support needs some work, and this doesn't make it better or worse. However, you can specify a diff between threads by doing {{{ bzr lpsend -r thread:..-1 }}} '''Question:''' Does this handle dependent branches? '''Answer:''' No, dependent branches are not currently supported for merge proposals. We do expect to resurrect the feature at some point, but it was much faster to start with the simple case. '''Question:''' Can I download the diff from the merge proposal in the web UI? '''Answer:''' Not yet, but this is a planned feature. However, if you receive an email about the merge proposal being created, it will include the diff as an attachment. '''Question:''' What URLs are recognized? '''Answer:''' lp:, bzr+ssh:, sftp: and http: are all recognized. Remote URLs for Remote Branches and Mirrored Branches will work. Decorated versions, such as nosmart+bzr+ssh: will not work. '''Question:''' Can I submit a branch that is not hosted on Launchpad? '''Answer:''' Yes. Launchpad will create !RemoteBranch for the source branch if the source is not represented on Launchpad. However, the target branch must be known to Launchpad. '''Question:''' Should I use the --no-patch option to bzr send? '''Answer:''' No. Launchpad uses that patch verbatim. If it's not present, LP cannot show a diff. '''Question:''' What if I want to use my editor, like review-submit did? '''Answer:''' You can configure Bazaar to use the "editor" mail client. '''Question:''' Creating a new merge proposal via the web no longer creates multiple emails. Why does creating a new merge proposal via {{{bzr send}}} create multiple emails? '''Answer:''' The API for sending a single email is not quite in sync with merge-proposal-by-email's needs. This is coming soon. '''Question:''' Will we be reinstating the lpreview plugin using the bzr send stuff? '''Answer:''' Ideally we will be adding the lpreview functionality to bzr send instead. That way, LP uses standardized functionality and our efforts on improving code review help others. |
As of Launchpad 2.1.12, Launchpad now supports creating merge proposals using bzr send.
One-time set-up
Please make sure you have your public and submit branches set properly. Below is an example ~/.bazaar/locations.conf
[/home/rockstar/Projects/launchpad/] submit_branch = /home/rockstar/Projects/launchpad/trunk push_location = bzr+ssh://bazaar.launchpad.net/~rockstar/launchpad/ push_location:policy = appendpath public_branch = bzr+ssh://bazaar.launchpad.net/~rockstar/launchpad/ public_branch:policy = appendpath submit_to = merge@code.launchpad.net [/home/rockstar/Projects/launchpad/trunk] public_branch = bzr+ssh://bazaar.launchpad.net/~launchpad-pqm/launchpad/devel
In bazaar.conf, add an entry to your aliases:
[ALIASES] lpsend=send --no-bundle
Client configuration
Due to bug #291847, it is necessary to specify your mail client on Intrepid. Possible values include: evolution, kmail, thunderbird, emacsclient, mutt
If your client is not supported, you can use "editor".
e.g.
[DEFAULT] mail_client = thunderbird
Claws
Bazaar's support for Claws is via xdg-utils, which is broken in Intrepid (see above). However, there is a tiny plugin that will will provide direct support for Claws:
cd ~/.bazaar/plugins bzr branch lp:~allenap/+junk/bzr-claws claws
Don't forget to set mail_client = claws too.
This also fixes a small annoyance when using xdg-utils with Claws. If you ask xdg-email to attach a file to the email, Claws will pop up a modal dialog box to confirm that a file has indeed been attached.
Direct support for Claws is present in bzr.dev, and will be released in bzr 1.11
Creating a New Merge Proposal
Once your environment is set up, bzr send is as easy as
bzr push; bzr lpsend
This will create a merge proposal and a diff and place them in your preferred email client to polish off and send to Launchpad. The body of your message will be used as the initial comment.
This example uses the lpsend alias, to ensure you specify --no-bundle. If you forget to supply --no-bundle, bzr send will not verify that your public branch is up-to-date. (Bundle support for Launchpad is coming soon.)
Frequently Asked Questions
Question: How do I specify revisions to generate the diff from?
Answer:When doing bzr submit, you may want to only generate a diff from a range of revisions. You can use -r parameter to specify the range, as below:
bzr lpsend -r 1234..1239
This will generate a diff from revno 1234 to 1239.
Question: Does this work with looms?
Answer: Launchpad's Loom support needs some work, and this doesn't make it better or worse. However, you can specify a diff between threads by doing
bzr lpsend -r thread:..-1
Question: Does this handle dependent branches?
Answer: No, dependent branches are not currently supported for merge proposals. We do expect to resurrect the feature at some point, but it was much faster to start with the simple case.
Question: Can I download the diff from the merge proposal in the web UI?
Answer: Not yet, but this is a planned feature. However, if you receive an email about the merge proposal being created, it will include the diff as an attachment.
Question: What URLs are recognized?
Answer: lp:, bzr+ssh:, sftp: and http: are all recognized. Remote URLs for Remote Branches and Mirrored Branches will work. Decorated versions, such as nosmart+bzr+ssh: will not work.
Question: Can I submit a branch that is not hosted on Launchpad?
Answer: Yes. Launchpad will create RemoteBranch for the source branch if the source is not represented on Launchpad. However, the target branch must be known to Launchpad.
Question: Should I use the --no-patch option to bzr send?
Answer: No. Launchpad uses that patch verbatim. If it's not present, LP cannot show a diff.
Question: What if I want to use my editor, like review-submit did?
Answer: You can configure Bazaar to use the "editor" mail client.
Question: Creating a new merge proposal via the web no longer creates multiple emails. Why does creating a new merge proposal via bzr send create multiple emails?
Answer: The API for sending a single email is not quite in sync with merge-proposal-by-email's needs. This is coming soon.
Question: Will we be reinstating the lpreview plugin using the bzr send stuff?
Answer: Ideally we will be adding the lpreview functionality to bzr send instead. That way, LP uses standardized functionality and our efforts on improving code review help others.
