:Account management; notably managing your SSH public keys for read-write developer access.
:Patch review (account sign-up via [http://identity.kde.org/ KDE Identity]), repository browser and other services.
* '''git.kde.org'''
=== Discontinued services ===
:Serves up the repositories, via git:// for anonymous read access and via SSH (on both ports 22 and 443) for read-write developer access (read-only access via HTTP is on the way).
The following services have been discontinued. Usually their role is now provided by other systems, but they typically are missing some important features which the previous systems had. The redesign unfortunately breaks the workflow e.g. in KDevelop which is not yet adapted to the new setup. The culled systems are listed here for reference as they may well still be referenced in older documentation.
* '''commits.kde.org'''
:Provides Git commit "short URLs", redirecting to the repository browser pages as appropriate ([http://commits.kde.org/324dd0cd/a8d1175f61e678f61b3643c867f212ad26ce6f44 example]).
* '''[http://projects.kde.org/ KDE Projects]''' (projects.kde.org)
* '''[http://projects.kde.org/ KDE Projects]''' (projects.kde.org)
:Central project hub and primary repository browser.
:Central project hub and primary repository browser.
:Replaced by: the sysadmin/repo-metadata repository (metadata information); phabricator.kde.org (browser)
:Alternative repository browser. At present the only way to view personal clones of project repositories and personal scratch repositories ([[#Personal repositories|see below]]), however the former are planned to appear in projects.kde.org in the future.
:Sends an email with each commit for the projects you want to watch.
:Patch review (account sign-up via [http://identity.kde.org/ KDE Identity]).
:The main git server. Should be used only for pushing new commits to a repository over the SSH protocol.
* '''commits.kde.org'''
* '''anongit.kde.org'''
:Provides Git commit "short URLs", redirecting to [http://projects.kde.org/ KDE Projects] and [http://gitweb.kde.org/ gitweb.kde.org] pages as appropriate ([http://commits.kde.org/324dd0cd/a8d1175f61e678f61b3643c867f212ad26ce6f44 example]).
:Several servers which allow read-only access to the repositories via the git:// and http:// protocols. They are requested to update when anyone pushes to a repo on git.kde.org, so it can be thought of as being always up-to-date.
== How to get read-write developer access ==
* '''[https://cgit.kde.org/ cgit.kde.org]'''
:Repository browser. It shows also personal clones of project repositories and personal scratch repositories ([[#Personal repositories|see below]]),.
KDE developer accounts are managed through [http://identity.kde.org/ KDE Identity]. If you already have a KDE SVN developer account, it has been imported into KDE Identity and you may use the Password Reset feature to set a password and manage your SSH public keys. If you don't have a developer account yet, you can request Developer Access in the website's menu upon registering and logging into your account.
:Patch review (account sign-up via [http://identity.kde.org/ KDE Identity]). [[Infrastructure/Phabricator|Phabricator]], repository browser, calendar and other services. Phabricator is currently being replaced by Invent and only the workboard component has not been migrated to Invent yet.
== Overview of repository URL schemes ==
=== URL prefixes ===
== How to get read-write developer access ==
Anonymous read-only access uses the following URL prefix:
KDE developer accounts are managed through [http://identity.kde.org/ KDE Identity]. If you already have a KDE SVN developer account, it has been imported into KDE Identity and you may use the Password Reset feature to set a password and manage your SSH public keys. If you don't have a developer account yet, you can request Developer Access in the website's menu upon registering and logging into your account.
git://git.kde.org/
== Information For KDE Developers ==
Read-write developer access uses this prefix instead:
For general information visit the page about [[Infrastructure/Git | the use of Git by KDE]].
git@git.kde.org:
To configure Git for your KDE Development environment, please see the [http://techbase.kde.org/Development/Git/Configuration KDE Git Configuration] page on TechBase.
=== Repository paths ===
You can find some simple step-by-step recipes for using the KDE Git repositories on the [http://techbase.kde.org/Development/Git/Recipes KDE Git Recipes] page on TechBase.
Following the prefix, here are the path schemes for different types of repositories:
== Some notes about repository URLs ==
* '''<project identifier>'''
=== URL prefixes ===
:A KDE project repository, be it part of the KDE SC, KDE Extragear or KDE Playground.
(KDevelop 5.x users please note: If you came here via the link in KDevelop, note that KDE projects has been '''discontinued''' and replaced by ''Invent''. So the neat automatic import of KDE projects ''no longer works'' and you have to do everything manually instead. Sorry!)
* '''websites/<address sans leading www. and dots replaced by dashes>'''
:A KDE website project, e.g. websites/projects-kde-org.
* '''sysadmin/<repository name>'''
:Non-public repositories used by KDE's sysadmin team.
* '''clones/<original repository path>/<KDE Identity user name>/<user-chosen repository name>'''
:Personal clones of project repositories, e.g. <tt>clones/konversation/hein/morecowbell</tt> or <tt>clones/websites/projects-kde-org/hein/pluginwork</tt> ([[#Personal clones of project repositories|more below]]).
* '''scratch/<KDE identity user name>/<user-chosen repository name>'''
:Personal scratch repositories are a means to start a new project or just to store your favorite .bashrc in a safe location: anything is allowed so long as it is related to KDE or your work for KDE in some way ([[#Personal scratch repositories|more below]]).
== Server-side commands ==
git.kde.org understands several server-side commands that can be used on the command line via SSH in this fashion:
:Shows a table of repository paths and path patterns you have the permission to see along with details about your access rights to them.
:A brief legend for the permission flags shown in the listing:
:* '''@R''' - Read permissions.
:* '''@W''' - Write permissions.
:* '''@C''' - Create permissions (e.g. the initial push to a newly-created repo).
:If you want to list actual repositories corresponding to patterns listed by <tt>info</tt>, such as your personal [[#Personal scratch repositories|scratch repositories]], see the <tt>[[#expand|expand]]</tt> command described next.
:Like <tt>[[#info|info]]</tt> above, but actually walks through the repositories to verify the information. It's much slower as a result, and should be used if <tt>info</tt> doesn't provide enough information. For example, <tt>info</tt> will list your personal [[#Personal scratch repositories|scratch space]] only in the form of a pattern while <tt>expand</tt> can list the actual repositories located there.
:The output is limited to about 20 rows. The optional regex parameter allows you to filter the listing.
Instead of remembering URL prefixes, you can also put the following in your <tt>~/.config/git/config</tt>:
:Used to delete a personal clone of a project repository or a personal scratch repository. Requires the repository to be unlocked first using the <tt>[[#unlock|unlock]]</tt> command and will additionally ask for confirmation. See also the <tt>[[#trash|trash]]</tt> command as an alternative to outright and irrevocable deletion.
:Moves a repository to the personal trash area, creating an entry in the form <tt><repository path>/<timestamp></tt> there. The timestamps, which have second precision, make it possible to have more than one version of a repository in the trash area at the same time.
:<span style="color:red">'''Note:'''</span> Entries in the personal trash area are automatically removed after 28 days!
*'''<span id="restore">restore <trash area entry></span>''' <small>[[#restore|(link here)]]</small>
:Restores an entry from the personal trash area (see the <tt>[[#list-trash|list-trash]]</tt> command below for how to list the contents of your personal trash area).
:<tt>restore</tt> will deny restoring an entry if doing so would overwrite an existing repository.
:Available only to repository and system administrators, this command enables hook scripts that git.kde.org will then execute during a push operation to the specified repository. The specified repository must be a project repository; the hook scripts are not available to [[#Personal repositories|personal repositories]].
:New, empty repositories start out with the hook scripts disabled so you can import large numbers of old commits without them being sent to the [https://mail.kde.org/mailman/listinfo/kde-commits kde-commits] mailing list and [http://www.cia.vc/ CIA.vc], and without commit message keywords (BUG, CCMAIL, etc.) being processed. Note that while the hook scripts are disabled only repository administrators can push commits to a repository.
:See also the <tt>[[#hooks-disable|hooks-disable]]</tt> command.
===Commands for system administrators===
*'''<span id="sudo">sudo <KDE Identity user name> <command></span>''' <small>[[#sudo|(link here)]]</small>
:Used by system administrators to run one of the above as another user.
:Disables the hook scripts git.kde.org normally executes during a push operation to a project repository. While the hook scripts are disabled only repository administrators can push commits to a repository. Both system and repository administrators have the ability to reenable the hook scripts using the <tt>[[#hooks-enable|hooks-enable]]</tt> command.
:Used by system administrators to recover deleted branches or mistaken force pushes (rewinds).
== Personal repositories ==
== Personal repositories ==
git.kde.org currently offers two types of personal repositories: Personal clones of project repositories and personal scratch repositories.
invent.kde.org currently offers two types of personal repositories: Personal clones of project repositories and personal repositories.
=== Personal clones of project repositories ===
=== Personal clones of project repositories ===
A personal clone of a project repository can be created using the server-side <tt>clone</tt> command on the command line:
A personal clone of a project repository can be created using the gitlab web interface.
ssh git@git.kde.org clone <path to source repository> <clone name>
This will create a clone of the source repository at <tt>clones/<path to source repository>/<KDE Identity user name>/<clone name></tt>. (See more examples of <tt>clone</tt> in action [[#clone|here]].)
This scheme makes it very easy to locate all personal clones of a given project and should be preferred over making one in your personal [[#Personal scratch repositories|scratch space]]. (In fact, the server-side <tt>clone</tt> command won't allow you to clone a project repository into your personal scratch space, but nothing technically prevents you from taking the detour of a local clone to achieve this.)
Personal clones of project repositories currently do not show up on [http://projects.kde.org KDE Projects], but we have plans to change that in the future. Until then, you can use [http://gitweb.kde.org/ gitweb.kde.org] to browse these repositories.
=== Personal scratch repositories ===
Personal scratch repositories are a means to start a new project or just to store your favorite .bashrc in a safe location: anything is allowed so long as it is related to KDE or your work for KDE in some way.
Creating one is easily done by just pushing:
git push --all [email protected]:scratch/<your KDE Identity user name>/<repo name of your choosing>
(Or you could use <tt>git remote add</tt> to add a remote to push to.)
Personal scratch repositories can be browsed on [http://gitweb.kde.org/ gitweb.kde.org].
If you feel your new project is ready for the wider world and/or wish to signal that it welcomes outside contributors, you may wish to promote it to the status of a KDE Playground project. KDE Playground project repositories are located at the top-level, i.e. the repository will be moved out of your scratch space and may have to be renamed in the event of a collision with an existing repository name. KDE Playground projects are featured on [http://projects.kde.org KDE Projects] and covered by the [https://mail.kde.org/mailman/listinfo/kde-commits kde-commits] mailing list (and thus [http://commitfilter.kde.org CommitFilter]), [http://lxr.kde.org/ LXR], the [http://www.englishbreakfastnetwork.net/ EBN] and [http://cia.vc/ CIA], unlike personal scratch repositories.
To request your scratch repository be promoted to the status of a KDE Playground project, you currently need to file a [https://bugs.kde.org/enter_sysadmin_request.cgi sysadmin request]. In the future we plan to provide a fully automated facility on [http://projects.kde.org KDE Projects].
Note that we have deliberately decided not to allow the direct creation of KDE Playground projects; the path to existence for a KDE Playground repository project always leads through a personal scratch space first. This is to give you the power to decide whether your project is ready, and also to force you to deliberate whether it truly is.
===Deleting personal repositories===
A personal repository can either be deleted outright and irrevocably by using the <tt>[[#destroy|destroy]]</tt> command (which requires you to <tt>[[#unlock|unlock]]</tt> it first to avoid accidental deletion), or you may move it to the personal trash area with the <tt>[[#trash|trash]]</tt> command.
'''Entries in the personal trash area are kept for 28 days,''' and can be resurrected at any moment during those 28 days by way of the <tt>[[#restore|restore]]</tt> command. You can list the current contents of your personal trash area with the <tt>[[#list-trash|list-trash]]</tt> command.
== Using ReviewBoard and post-review ==
A very comfortable way of posting changes for review is [http://git.reviewboard.kde.org ReviewBoard], where every project repository has its own entry.
=== Creating your changeset ===
To create your changeset, you probably want to work in a separate branch - or even in your clone. This is actually suggested and the proper way to do changesets in Git. You can create any number of commits, amend them, and do whatever you want to do - it won't affect the next phases, as you will submit the whole branch for review.
=== Using post-review to post changes ===
Once you are done with the above, it is time to post changes to ReviewBoard. The easiest and most comfortable way to do that is <tt>[http://www.reviewboard.org/docs/manual/dev/users/tools/post-review/ post-review]</tt>, a handy command line tool which takes care of creating review requests for you.
==== Prerequisites ====
The following has to be only once to make your local clone fit for use with <tt>post-review</tt>.
First of all, you have to tell it about the ReviewBoard server. If your project does not ship with a <tt>.reviewboardrc</tt> file (encourage the project manager to do that!), the first thing you have to run is:
This will create a clone of the source repository in your personal namespace.
ReviewBoard currently only knows the project repositories by their git:// URLs, so you need a remote using the git:// URL. If your origin remote is already using the git:// URL, you are done now. If not you need to add another remote.
=== Personal repositories ===
Let's suppose our project is [https://projects.kde.org/projects/extragear/multimedia/amarok Amarok], and our origin is <tt>git@git.kde.org:amarok</tt>. We need to run:
Personal scratch repositories are a means to start a new project or just to store your favorite <tt>.bashrc</tt> in a safe location: anything is allowed so long as it is related to KDE or your work for KDE in some way.
You can create and delete a new personal repository using the gitlab web interface.
git fetch anonupstream
If on the other hand your origin remote URL already used the git:// protocol, just substitute <tt>anonupstream</tt> with <tt>origin</tt> throughout the rest of the tutorial.
To request your scratch repository be promoted to the status of a KDE Playground project, you currently need to file a [https://go.kde.org/systickets sysadmin repo request]. For details, see the description of an [[Policies/Application Lifecycle|Application Lifecycle]].
==== Creating a review request ====
== Advanced Git ==
Now we have to tell ReviewBoard where our changes are. A good practice before doing that is rebasing your branch onto the branch you want to target for merge. So, supposing you want to target <tt>master</tt>, you would run:
=== Safety Precautions ===
git rebase master
With these techniques, always work on a disposable copy of the repo with all the remotes removed, so if you screw up, it doesn't really matter. Also, work on a separate branch. That way, you can usually use <tt>git reset --hard <original-branch></tt> to get back to the starting state.
Of course, be sure that <tt>master</tt> is up-to-date with the remote before doing that!
Also, make sure there are no grafts around (eg: linking to the old kdelibs history in the case of frameworks). The safest way to do this is to use fresh checkouts.
You are now ready for posting the changes. The <tt>post-review</tt> command should look something like this:
The <tt>git-merge-repo</tt> script in [https://projects.kde.org/projects/kde/kdesdk/kde-dev-scripts kde-dev-scripts] can merge the tree and history of one git repository into another.
This command tells <tt>post-review</tt> that your branch is based upon <tt>master</tt>, and it is set to track the remote branch <tt>anonupstream/master</tt>. You can also give <tt>post-review</tt> some more arguments to avoid using the web interface later - have a look at the [http://www.reviewboard.org/docs/manual/dev/users/tools/post-review/ user manual] for more on that.
First, create a commit in the source repo that removes any files you don't want to copy, and rearrange the remaining files to be as you want them to appear in the target repo. It is important the HEAD of the source and target repositories have completely disjoint trees (so you could copy one tree into the other with no file conflicts).
After the command has been run a web address will be shown in the terminal, pointing at your review request.
Then go to the root of the target repository and run
==== Updating a review request ====
/path/to/kde-dev-scripts/git-merge-repo <path to source repo>
If you need to update a review request, you can invoke <tt>post-review</tt> with an additional <tt>-r</tt> argument, which should be the numeric id of the review request you want to update. Supposing you want to update the review request 54, you would run:
This will preserve commit identities (unless you filter the source repository - see below).
:<span style="color:red">'''Note:'''</span> Before pushing such a merge, talk to [http://sysadmin.kde.org/ sysadmin] (ideally on #kde-sysadmin in irc). They can temporarily disable commit hooks (like CCMAIL and BUG) so that people do not get emails about old commits.
==== Creating a ReviewBoard-compatible diff ====
=== Filtering ===
In some rare cases you simply want to generate a diff and submit it to ReviewBoard later. You can do that by running:
<tt>git filter-branch</tt> allows you to edit history. This is useful when you want to merge only a small part of one repository into another. You can trim the tree, and also alter the commit messages (for example to add information about the origin of the commits).
post-review --parent=master -n > your-patch.patch
A combination of <tt>--tree-filter</tt>, <tt>--prune-empty</tt> and <tt>--msg-filter</tt> generally gets what you want. For example,
== Requesting project migrations from KDE SVN or Gitorious.org ==
--msg-filter 'cat; echo; echo "Commit $GIT_COMMIT in <source-repo>"' \
HEAD
To get your project moved from KDE SVN or Gitorious.org to git.kde.org, you have to file a [https://bugs.kde.org/enter_sysadmin_request.cgi sysadmin request] providing the following information:
This example will remove everything that does not match <tt>foo.*</tt>. Note the <tt>-path</tt> argument to <tt>find</tt> that makes sure you don't delete any of git's own files. <tt>--prune-empty</tt> will remove non-merge commits that no longer have any effect on the tree (you can run <tt>git rebase</tt> after to trim the merge commits if you want). <tt>--msg-filter</tt> adds information about where the commit came from (don't forget to change <tt><source-repo></tt>!)
* The name and description of the project.
More complex filters are possible. Have a look at the man page for <tt>git-filter-branch</tt>. Note that while you could use the commit message filter to neuter commit hook keywords like CCMAIL, it is better to ask a sysadmin to disable the commit hooks temporarily while you push.
* The current location of the project.
* Its current or intended module (e.g. playground/utils or extragear/network).
* Which KDE Identity user name(s) should have admin rights to the repository and the entry on [http://projects.kde.org KDE Projects].
* The email address that the [http://git.reviewboard.kde.org/ ReviewBoard] group for the project should send emails to.
* The date and time the migration should take place (can be "asap").
When we have completed processing your request, there will be an empty repository at the chosen path ([[#Overview of repository URL schemes|more here]]) that the repository administrators can push the data into. Once you are done pushing everything to the repository, use the <tt>[[#hooks-enable|hooks-enable]]</tt> command to enable the commit hooks and allow write access to non-administrators.
See [http://whileimautomaton.net/2010/04/03012432 mastering git filter-branch: points to extract a subproject] for more helpful hints.
Patch review (account sign-up via KDE Identity), repository browser and other services.
Discontinued services
The following services have been discontinued. Usually their role is now provided by other systems, but they typically are missing some important features which the previous systems had. The redesign unfortunately breaks the workflow e.g. in KDevelop which is not yet adapted to the new setup. The culled systems are listed here for reference as they may well still be referenced in older documentation.
commits.kde.org
Provides Git commit "short URLs", redirecting to the repository browser pages as appropriate (example).
Sends an email with each commit for the projects you want to watch.
git.kde.org
The main git server. Should be used only for pushing new commits to a repository over the SSH protocol.
anongit.kde.org
Several servers which allow read-only access to the repositories via the git:// and http:// protocols. They are requested to update when anyone pushes to a repo on git.kde.org, so it can be thought of as being always up-to-date.
Patch review (account sign-up via KDE Identity). Phabricator, repository browser, calendar and other services. Phabricator is currently being replaced by Invent and only the workboard component has not been migrated to Invent yet.
How to get read-write developer access
KDE developer accounts are managed through KDE Identity. If you already have a KDE SVN developer account, it has been imported into KDE Identity and you may use the Password Reset feature to set a password and manage your SSH public keys. If you don't have a developer account yet, you can request Developer Access in the website's menu upon registering and logging into your account.
To configure Git for your KDE Development environment, please see the KDE Git Configuration page on TechBase.
You can find some simple step-by-step recipes for using the KDE Git repositories on the KDE Git Recipes page on TechBase.
Some notes about repository URLs
URL prefixes
(KDevelop 5.x users please note: If you came here via the link in KDevelop, note that KDE projects has been discontinued and replaced by Invent. So the neat automatic import of KDE projects no longer works and you have to do everything manually instead. Sorry!)
Let Git rewrite URL prefixes
Instead of remembering URL prefixes, you can also put the following in your ~/.config/git/config:
invent.kde.org currently offers two types of personal repositories: Personal clones of project repositories and personal repositories.
Personal clones of project repositories
A personal clone of a project repository can be created using the gitlab web interface.
This will create a clone of the source repository in your personal namespace.
Personal repositories
Personal scratch repositories are a means to start a new project or just to store your favorite .bashrc in a safe location: anything is allowed so long as it is related to KDE or your work for KDE in some way.
You can create and delete a new personal repository using the gitlab web interface.
To request your scratch repository be promoted to the status of a KDE Playground project, you currently need to file a sysadmin repo request. For details, see the description of an Application Lifecycle.
Advanced Git
Safety Precautions
With these techniques, always work on a disposable copy of the repo with all the remotes removed, so if you screw up, it doesn't really matter. Also, work on a separate branch. That way, you can usually use git reset --hard <original-branch> to get back to the starting state.
Also, make sure there are no grafts around (eg: linking to the old kdelibs history in the case of frameworks). The safest way to do this is to use fresh checkouts.
Merging repositories
The git-merge-repo script in kde-dev-scripts can merge the tree and history of one git repository into another.
First, create a commit in the source repo that removes any files you don't want to copy, and rearrange the remaining files to be as you want them to appear in the target repo. It is important the HEAD of the source and target repositories have completely disjoint trees (so you could copy one tree into the other with no file conflicts).
Then go to the root of the target repository and run
/path/to/kde-dev-scripts/git-merge-repo <path to source repo>
This will preserve commit identities (unless you filter the source repository - see below).
Note: Before pushing such a merge, talk to sysadmin (ideally on #kde-sysadmin in irc). They can temporarily disable commit hooks (like CCMAIL and BUG) so that people do not get emails about old commits.
Filtering
git filter-branch allows you to edit history. This is useful when you want to merge only a small part of one repository into another. You can trim the tree, and also alter the commit messages (for example to add information about the origin of the commits).
A combination of --tree-filter, --prune-empty and --msg-filter generally gets what you want. For example,
git filter-branch --prune-empty \
--tree-filter "find -type f -\! -path './.git/*' -\! -name foo.\* -delete" \
--msg-filter 'cat; echo; echo "Commit $GIT_COMMIT in <source-repo>"' \
HEAD
This example will remove everything that does not match foo.*. Note the -path argument to find that makes sure you don't delete any of git's own files. --prune-empty will remove non-merge commits that no longer have any effect on the tree (you can run git rebase after to trim the merge commits if you want). --msg-filter adds information about where the commit came from (don't forget to change <source-repo>!)
More complex filters are possible. Have a look at the man page for git-filter-branch. Note that while you could use the commit message filter to neuter commit hook keywords like CCMAIL, it is better to ask a sysadmin to disable the commit hooks temporarily while you push.
