Infrastructure/Git
<languages /> <translate> This is the hub page for all information about the use of Git by KDE.
This section provides details on using the KDE Git infrastructure. This is intended for use by KDE developers to find out how KDE uses Git and how to set up Git for use with KDE.
Git at KDE
KDE currently offers code hosting using Git. Additionally, KDE also maintains a limited Subversion infrastructure for certain special projects, such as translations and older websites.
Anonymous access
Both Git and Subversion repositories can be accessed anonymously by anyone. This access takes place from anongit.kde.org and anonsvn.kde.org for Git and Subversion respectively, and grants read only access to the same repositories which are available to contributors with developer accounts.
For Git, it is possible to perform clones and fetches over either the Git or HTTP protocols, depending on your situation. Access over HTTP is usually necessary when you are behind a restrictive network firewall. If your network access is unreliable, then you may want to download an archive of the repository instead, which you can freely resume the download of, as well as commit to and update later by using the usual git commands. These archives can be accessed at https://anongit.kde.org/<repository>/<repository>-latest.tar.gz.
KDE also maintains a mirror of its mainline Git repositories on GitHub. This mirror is read-only, and disables all of GitHub's additional features, such as issues, the wiki, and downloads, in favour of KDE's own hosted services. Additionally, pull requests on these repositories are not accepted, but code changes can always be accepted through KDE's code-review services.
For Subversion, access is only provided over the Subversion protocol. If you are behind a restrictive firewall and need to access the KDE Subversion repository anonymously (and have no other means of network access), please file a ticket.
Pushing
Push or commit access to all KDE code repositories is open to any holder of a KDE developer account, subject to few limitations. This model allows contributors to easily make contributions to all parts of KDE without needing further approval. All commits made to either Git or Subversion are subject to commit hooks which will perform a few quality control checks and can take other actions on behalf of the developer. In the case of both Git and Subversion it is only possible to commit over SSH.
With KDE Git, it is recommended to use a shortcut to access repositories instead of directly cloning them from the Git server itself. This shortcut allows you to use a local mirror of the repositories, and should improve response times. To setup a kde: shortcut, you should add the following configuration block to ~/.gitconfig. If your network blocks the Git protocol, then you can exchange that for HTTP instead.
[url "git://anongit.kde.org/"]
insteadOf = kde:
[url "[email protected]:"]
pushInsteadOf = kde:
Once setup as above, you can clone and push to repositories through the URL kde:repository.
As Subversion requires that checkouts you are committing from are made from the same location you are committing to, checkouts should be made from the Subversion server directly. It can be accessed at svn+ssh://[email protected]/home/kde/. If you have existing checkouts, you will need to relocate them using the svn switch command before you are able to commit.
Browsing
To allow for quick review of code, web repository browsers exist for both Git and Subversion repositories. Those interested in browsing Subversion should visit WebSVN, which will contain the latest commits made to the KDE Subversion repository subject to a delay of 10 minutes at maximum.
In the case of Git, repository browsing is available via QuickGit. Additionally, all mainline repositories are available on GitHub and can be browsed there. Please note that scratch and clone repositories are only browsable on Quickgit.
If you need to link to materials which are stored in either Git or Subversion repositories on KDE infrastructure, it is requested that you do not embed the content directly, but simply link to it. Embedding content causes significantly higher load on the repository browser servers, making it unavailable for others wishing to use it. This is particularly relevant for blog posts on Planet or any other high traffic web page.
New repositories
To allow for free form development in a manner similar to Subversion did, KDE Git allows personal repositories to be created on demand as needed. Two types of personal repository are available:
Scratch repositories are created on the fly when a developer pushes to them for the first time, and exist at scratch/username/myRepo. These are recommended for new development work.
Clone repositories are created by cloning an existing project repository, and exist at clones/project/username/myClone. They are created by running ssh [email protected] clone project myClone where myClone is the name you wish to call your clone, and project is the name of the repository you are cloning.
Personal repositories can be deleted at any time.
From time to time it may be necessary to create new project repositories, to contain newly developed applications, migrate existing applications from Subversion or to bring new projects under the KDE umbrella. New repositories can be requested by filing a ticket, and will usually be created at the top level on git.kde.org.
Extra Karma
At times contributors may find it necessary to push or commit to certain repositories or paths which are protected. In this case the server will reject your request with a message such as insufficient karma or access denied. This protection is most often applied to repositories which run parts of the infrastructure such as websites or other crucial components.
If you would like to request access to these protected areas, please file a ticket, mentioning which repositories or paths you are trying to change.
A complete manual on how to use KDE's Git services, along with some best practices, is available on the KDE Community Wiki.
Hooks
Kde provides some git hooks to perform and automatize some actions on push.
Server Fingerprints
The SSH host server key fingerprints are as follows for both Git and Subversion access:
- RSA:
51:d4:83:0d:47:da:da:03:fc:b7:81:67:5e:48:fe:1a - DSA:
f0:0d:c0:3e:be:0b:52:30:42:17:6b:40:21:94:04:d2 - ECDSA:
fe:0d:d6:6e:85:1b:8d:3d:45:a7:94:e0:0c:88:65:fb
KDE and Git (to merge with the above text)
The KDE Git System Administrators Manual is a useful resource for more details on the technical implementation of the KDE Git infrastructure.
For more information on how the KDE Git Repositories are organized, please see the Sources page or the KDE Git Projects page.
Please note that some KDE modules are still using SVN, for more details read the Using Subversion with KDE page.
KDE Git Configuration
How to configure Git for use with the KDE infrastructure.
Please see the Git Configuration page.
KDE Git Policies
KDE policies on Git. More generic development policies go elsewhere.
No formal workflow policy currently exists, but a number of draft proposals have been made:
- Simple Workflow
- Feature Branch Workflow
- Feature Development Workflow
- Git Workflow on the Community Wiki
Other:
- The new Commit Policy is being reviewed, applied to both SVN and Git.
- GitHub Mirror has been created and policy is in development (Sep 2015).
KDE Git Recipes
Short recipes for using Git with the KDE infrastructure.
Please see the Git Recipes page.
KDE Git Tutorials
More in-depth instructions in using Git.
Please help filling this section by
- checking the links at the bottom of the page and see which still have valid content
- write tutorials yourself
External Git Resources
Links to useful external sites about Git
Official Documentation
Git for SVN Users
Git books
- Pro Git - An easy to understand book on git (CC licensed).
- The git community book, also as a pdf
Tutorials
- Git Magic - A good intro to git (in several languages!)
- Essential reading if you want to truly understand git.
- tryGit A 15 minute online interactive tutorial
Cheat Sheets
(broken image, get it from Media:Zrusin-git-cheat-sheet-medium.png) </translate>
