Diff for "Code/Git"

Not logged in - Log In / Register

Differences between revisions 1 and 21 (spanning 20 versions)
Revision 1 as of 2015-03-31 11:12:28
Size: 6072
Editor: cjwatson
Comment: first draft
Revision 21 as of 2016-02-12 21:26:06
Size: 7627
Editor: cjwatson
Comment: clarify personal repositories
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
Launchpad features experimental support for hosting [[http://git-scm.com/|Git]] repositories. This is distinct from the [[Code/Imports|code import]] facility that Launchpad has included for many years; it will shortly be possible to host Git repositories on Launchpad directly. Launchpad supports hosting [[http://git-scm.com/|Git]] repositories. This is distinct from the [[Code/Imports|code import]] facility that Launchpad has included for many years; it is now possible to host Git repositories on Launchpad directly.
Line 13: Line 13:
As of the end of March 2015, the bare bones of Git hosting support are live on our "qastaging" site. This means: This summary is up-to-date as of February 2016.
Line 15: Line 15:
 * all changes made will be reset - this is not yet a persistent hosting service, but is strictly for experimenting and finding bugs in Launchpad
 * the URL format is not guaranteed to be stable
 * everything is on qastaging.launchpad.net and git.qastaging.paddev.net, rather than on the main launchpad.net site
 * the hosting backend is still quite basic and may have scaling problems
Launchpad supports Git hosting. This means that you can:
Line 20: Line 17:
Within these constraints, you can:

* push Git repositories to qastaging over SSH
 * push Git repositories over SSH
Line 24: Line 19:
 * see summary information on repositories in the Launchpad web UI on qastaging  * see summary information on repositories and the branches they contain in the Launchpad web UI
Line 26: Line 21:

Just don't keep the only copy of your repository on qastaging!
 * push and clone private repositories, if you have a commercial subscription to Launchpad
 * propose merges from one branch to another, including in a different repository, provided that they are against the same project or package
 * add [[API/Webhooks|webhooks]] to notify third-party services when repositories are changed
 * use [[Packaging/SourceBuilds|recipes]] to build packages in PPAs for code in Launchpad-hosted Git repositories (if you are in [[https://launchpad.net/~launchpad-beta-testers|~launchpad-beta-testers]])
Line 31: Line 28:
Our top priority is to polish things up so that this can land on Launchpad production, and to this end we appreciate your feedback on any bugs you find. Here's a short list of known bugs that you don't need to tell us about:

 * finding the URL for a new repository after you've pushed it is hard
 * pushing forks of new repositories requires pushing all the data again
 * pushing a new default repository for a target (project or distribution source package) does not also set the owner's default for that target
Line 39: Line 30:
 * merge proposals (these are very heavily used by many teams, including Launchpad itself, so are the top feature priority)
 * subscriptions
 * useful subscriptions (currently only attribute change notifications work, which are not usually very interesting in themselves)
Line 43: Line 33:
 * webhooks
Line 45: Line 34:

Here's a short list of known bugs that you don't need to tell us about:

 * the interface for registering merge proposals is very rough
Line 49: Line 42:
[url "git+ssh://USER@git.qastaging.paddev.net/"]
        insteadof = lpqas:
[url "git+ssh://USER@git.launchpad.net/"]
        insteadof = lp:
Line 52: Line 45:
This allows you to type `git clone lpqas:REPOSITORY` instead of `git clone git+ssh://git.qastaging.paddev.net/REPOSITORY`.  (Of course, when we add Git support to production we will update this documentation to recommend `lp:` instead.) This allows you to type `git clone lp:REPOSITORY` instead of `git clone git+ssh://git.launchpad.net/REPOSITORY`.
Line 55: Line 48:

For personal repositories, you can also add: {{{
[url "git+ssh://USER@git.launchpad.net/~USER/+git/"]
        insteadof = lpme:
}}}
Line 59: Line 57:
$ git clone lpqas:PROJECT $ git clone lp:PROJECT
Line 62: Line 60:
For example, `git clone lpqas:launchpad` fetches Launchpad itself. For example, `git clone lp:launchpad` fetches Launchpad itself (or will once we've finished converting it to Git!).
Line 71: Line 69:
$ git remote add lpqas lpqas:PROJECT $ git remote add origin lp:PROJECT
Line 75: Line 73:
$ git remote add lpqas lpqas:~USER/PROJECT $ git remote add origin lp:~USER/PROJECT
Line 79: Line 77:
$ git push lpqas my-changes $ git push origin my-changes
Line 86: Line 84:
 * https://code.qastaging.launchpad.net/~OWNER/PROJECT/+git/REPOSITORY
   This identifies a repository for an upstream project.

 * https://code.qastaging
.launchpad.net/~OWNER/DISTRIBUTION/+source/SOURCE/+git/REPOSITORY
   This identifies a repository for a source package in a distribution.

 * https://code.qastaging
.launchpad.net/~OWNER/+git/REPOSITORY
  
This identifies a "personal" repository with no particular connection to any project or package.
  https://code.launchpad.net/~OWNER/PROJECT/+git/REPOSITORY:: This identifies a repository for an upstream project.
  https://code.launchpad.net/~OWNER/DISTRIBUTION/+source/SOURCE/+git/REPOSITORY:: This identifies a repository for a source package in a distribution.
  https://code.launchpad.net/~OWNER/+git/REPOSITORY:: This identifies a "personal" repository with no particular connection to any project or package (like "+junk" in Launchpad's Bazaar code hosting).
Line 97: Line 90:
 * https://code.qastaging.launchpad.net/PROJECT
   This is the default repository for an upstream project.

 * https://code.qastaging
.launchpad.net/DISTRIBUTION/+source/SOURCE
  
This is the default repository for a source package in a distribution.
  https://code.launchpad.net/PROJECT:: This is the default repository for an upstream project.
  https://code.launchpad.net/DISTRIBUTION/+source/SOURCE:: This is the default repository for a source package in a distribution.
Line 105: Line 95:
 * https://code.qastaging.launchpad.net/~OWNER/PROJECT
   This is an owner's default repository for an upstream project.

 * https://code.qastaging
.launchpad.net/~OWNER/DISTRIBUTION/+source/SOURCE
  
This is an owner's default repository for a source package in a distribution.
  https://code.launchpad.net/~OWNER/PROJECT:: This is an owner's default repository for an upstream project.
  https://code.launchpad.net/~OWNER/DISTRIBUTION/+source/SOURCE:: This is an owner's default repository for a source package in a distribution.
Line 112: Line 99:

= Converting from Bazaar to Git =

There [[https://www.google.com/search?{google:acceptedSuggestion}oq=convert&sourceid=chrome&client=ubuntu&channel=cs&ie=UTF-8&q=convert+from+bzr+to+git|are]] [[https://astrofloyd.wordpress.com/2012/09/06/convert-bzr-to-git/|several]] [[http://www.fusonic.net/en/blog/2013/03/26/migrating-from-bazaar-to-git/|useful]] [[http://blog.timmattison.com/archives/2011/06/13/how-to-convert-from-bzr-to-git-on-debianubuntu/|recommendations]] online for how to convert from Bazaar to Git. Here's one way that preserves tags and does a pretty good job for relatively simple Bazaar branches.

{{{
$ cd /some/place # parent directory of Bazaar branch
$ mkdir new-git-repo
$ cd new-git-repo
$ git init .
$ bzr fast-export --export-marks=../marks.bzr ../old-bzr-branch | git fast-import --export-marks=../marks.git
$ git checkout master
}}}

Now the `new-git-repo` directory is a Git repository with history equivalent to your old Bazaar branch. You should push it somewhere, and to ensure that everything is correct you should re-clone it locally to whatever final destination path you want to work in.

If you have several different Bazaar branches that form part of the same project, or if your Bazaar branches constitute packaging for a project whose upstream is in revision control elsewhere, then you may well want to do a more careful conversion. For this, [[http://www.catb.org/~esr/reposurgeon/|reposurgeon]] is an excellent tool: it gives you a language for describing the transformations you want to make to your input branches, so you can run the migration several times with different tweaks before deciding that the result is the one you want to publish to the world.

Once you're ready to use Git by default for your project, you can configure this from https://launchpad.net/PROJECT/+configure-code (which is linked from the "Configuration Progress" section of the main project page on Launchpad).

Launchpad Help > Code > Git

Overview

Launchpad supports hosting Git repositories. This is distinct from the code import facility that Launchpad has included for many years; it is now possible to host Git repositories on Launchpad directly.

Git repositories use a somewhat different model from Bazaar branches: operations such as cloning happen at the level of a repository, but it is common for a single repository to contain many branches. This means that the Launchpad interface needs to be laid out somewhat differently to support that.

What's supported?

This summary is up-to-date as of February 2016.

Launchpad supports Git hosting. This means that you can:

  • push Git repositories over SSH
  • clone repositories over git://, SSH, or HTTPS
  • see summary information on repositories and the branches they contain in the Launchpad web UI
  • follow links from the Launchpad web UI to a full-featured code browser
  • push and clone private repositories, if you have a commercial subscription to Launchpad
  • propose merges from one branch to another, including in a different repository, provided that they are against the same project or package
  • add webhooks to notify third-party services when repositories are changed

  • use recipes to build packages in PPAs for code in Launchpad-hosted Git repositories (if you are in ~launchpad-beta-testers)

What will be supported?

Launchpad's Bazaar support has grown many features over the years, and it will take some time to bring our Git support up to full parity with it. Here's an incomplete list of some of the features we expect to add:

  • useful subscriptions (currently only attribute change notifications work, which are not usually very interesting in themselves)
  • RSS feeds
  • mirroring
  • an integrated code browser

Here's a short list of known bugs that you don't need to tell us about:

  • the interface for registering merge proposals is very rough

Configuring Git

Git identifies repositories using URLs. Unlike Bazaar, there is no built-in abbreviation for repositories hosted on Launchpad, but it is very easy to add such a thing yourself. Edit ~/.gitconfig and add these lines, where USER is your Launchpad username:

[url "git+ssh://USER@git.launchpad.net/"]
        insteadof = lp:

This allows you to type git clone lp:REPOSITORY instead of git clone git+ssh://git.launchpad.net/REPOSITORY.

The rest of this documentation assumes that you have configured Git this way.

For personal repositories, you can also add:

[url "git+ssh://USER@git.launchpad.net/~USER/+git/"]
        insteadof = lpme:

Getting code

You can fetch the default repository for a project like this:

$ git clone lp:PROJECT

For example, git clone lp:launchpad fetches Launchpad itself (or will once we've finished converting it to Git!).

To keep your local clone up to date, run:

$ git pull

Pushing code

You can add a "remote" to your repository like this, if you own the project:

$ git remote add origin lp:PROJECT

Or like this (where USER is your Launchpad username), if you do not own the project:

$ git remote add origin lp:~USER/PROJECT

Now, you can push a branch using a command such as this:

$ git push origin my-changes

Repository URLs

Every Git repository hosted on Launchpad has a full "canonical" URL of one of these forms (these are the versions you'd use in a web browser; you only need to change the scheme and host parts for the command-line Git client):

https://code.launchpad.net/~OWNER/PROJECT/+git/REPOSITORY
This identifies a repository for an upstream project.
https://code.launchpad.net/~OWNER/DISTRIBUTION/+source/SOURCE/+git/REPOSITORY
This identifies a repository for a source package in a distribution.
https://code.launchpad.net/~OWNER/+git/REPOSITORY
This identifies a "personal" repository with no particular connection to any project or package (like "+junk" in Launchpad's Bazaar code hosting).

These are unique, but can involve quite a lot of typing, and in most cases there's no need for more than one repository per owner and target (project or package). Launchpad therefore has the notion of "default repositories". A repository can be the default for a target, in which case it has one of these forms:

https://code.launchpad.net/PROJECT
This is the default repository for an upstream project.
https://code.launchpad.net/DISTRIBUTION/+source/SOURCE
This is the default repository for a source package in a distribution.

Or a repository can be a person's or a team's default for a target, in which case it has one of these forms:

https://code.launchpad.net/~OWNER/PROJECT
This is an owner's default repository for an upstream project.
https://code.launchpad.net/~OWNER/DISTRIBUTION/+source/SOURCE
This is an owner's default repository for a source package in a distribution.

We expect that projects hosting their code on Launchpad will normally have their primary repository set as the default for the project, and contributors will normally push to branches in owner-default repositories. The extra flexibility with named repositories allows for situations such as separate private repositories containing embargoed security fixes.

Converting from Bazaar to Git

There are several useful recommendations online for how to convert from Bazaar to Git. Here's one way that preserves tags and does a pretty good job for relatively simple Bazaar branches.

$ cd /some/place  # parent directory of Bazaar branch
$ mkdir new-git-repo
$ cd new-git-repo
$ git init .
$ bzr fast-export --export-marks=../marks.bzr ../old-bzr-branch | git fast-import --export-marks=../marks.git
$ git checkout master

Now the new-git-repo directory is a Git repository with history equivalent to your old Bazaar branch. You should push it somewhere, and to ensure that everything is correct you should re-clone it locally to whatever final destination path you want to work in.

If you have several different Bazaar branches that form part of the same project, or if your Bazaar branches constitute packaging for a project whose upstream is in revision control elsewhere, then you may well want to do a more careful conversion. For this, reposurgeon is an excellent tool: it gives you a language for describing the transformations you want to make to your input branches, so you can run the migration several times with different tweaks before deciding that the result is the one you want to publish to the world.

Once you're ready to use Git by default for your project, you can configure this from https://launchpad.net/PROJECT/+configure-code (which is linked from the "Configuration Progress" section of the main project page on Launchpad).

Code/Git (last edited 2019-01-10 20:09:47 by cjwatson)