Infrastructure/Git: Difference between revisions

From KDE Community Wiki
m (remove dead link)
 
(73 intermediate revisions by 28 users not shown)
Line 1: Line 1:
[[Category:Needs Attention]]
This is the hub page for all information about the use of Git by KDE.
This is the hub page for all information about the use of Git by KDE.


This page is a work in progress where all new Git material is being organised. Most of these sections will eventually be moved to their own pages. Feel free to add stuff.
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 https://invent.kde.org/ and <code>anonsvn.kde.org</code> for Git and Subversion respectively, and grants read-only access to the same repositories which are available to contributors with developer accounts.
 
KDE also maintains a mirror of its mainline Git repositories on [https://github.com/kde/ 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. Code changes should use the official KDE git repositories https://invent.kde.org/. And still, GitHub may be used / searched more intuitively than the alternatives. E.g. sign into github.com, then search for source code in the entire "KDE" organization with a URL such as https://github.com/search?q=org%3AKDE+KMessageBox Then click on "Code" or "Commits".
 
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 [https://go.kde.org/u/systickets 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 <code>kde:</code> shortcut, you should add the following configuration block to <code>~/.config/git/config</code>. If your network blocks the Git protocol, then you can exchange that for HTTP instead.
 
<pre>[url &quot;https://invent.kde.org/&quot;]
    insteadOf = kde:
[url &quot;[email protected]:&quot;]
    pushInsteadOf = kde:</pre>
Once setup as above, you can clone and push to repositories through the URL <code>kde:group/repository</code>.


== KDE and Git ==
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 <code>svn+ssh://[email protected]/home/kde/</code>. If you have existing checkouts, you will need to relocate them using the <code>svn switch</code> command before you are able to commit.


This section provides details on using the KDE Git infrastructure.
=== Browsing ===


A primary resource is still http://community.kde.org/Sysadmin/GitKdeOrgManual
To allow for quick review of code, web repository browsers exist for both Git and Subversion repositories. Those interested in browsing Subversion should visit [https://websvn.kde.org/ WebSVN], which will contain the latest commits made to the KDE Subversion repository subject to a delay of 10 minutes at maximum.


=== KDE Git Configuration ===
In the case of Git, repository browsing is available via [https://invent.kde.org/ GitLab]. Additionally, all mainline repositories are available on [https://github.com/kde GitHub] and can be browsed there. Please note that personal repositories are only browsable on our GitLab, they are not mirrored to GitHub.


How to configure Git for use with the KDE infrastructure.
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, such as images, 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.


Please see the [[/Configuration|Git Configuration]] page.
=== New repositories ===


=== KDE Git Policies ===
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. You can [https://invent.kde.org/projects/new create personal repositories] from the GitLab web interface. You can also "fork" an existing official KDE repository.


KDE policies on Git.  More generic development policies go elsewhere.
Personal repositories and forks can be deleted at any time.


=== KDE Git Recipes ===
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 [https://go.kde.org/u/systickets ticket], and will be created in the appropriate group on invent.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 [https://go.kde.org/u/systickets ticket], mentioning which repositories or paths you are trying to change.


Short recipes for using Git with the KDE infrastructure.
A complete manual on how to use KDE's Git services, along with some best practices, is available on the [http://community.kde.org/Sysadmin/GitKdeOrgManual KDE Community Wiki].


Please see the [[/Recipes|Git Recipes]] page.
=== Hooks ===
Kde provides some [[/Hooks |git hooks]] to perform and automatize some actions on push.


=== KDE Git Tutorials ===
=== Server Fingerprints ===
The SSH host server key fingerprints are as follows for both Git and Subversion access:


More in-depth instructions in using Git.
* '''ED25519-256 (SHA256)''': <code>zHdK2R/S6s5Oj71N0s8LHWCXXsUt+DCztd+GjzW9KlU</code>
* '''ECDSA-256 (SHA256)''': <code>ZNBg4AkRxbt/N6xzpt7GbmmS78A3WFy5lz0l/cPHbcE</code>
* '''RSA-3072 (SHA256)''': <code>KxAoV6VsbKvAocFZCJlxtmPDScmUCRNiUiOCSXNSC/k</code>


Please see the outdated [[Infrastructure/Tutorials/Git|KDE tutorial]] page which needs major revision.
([https://mail.kde.org/pipermail/kde-devel/2023-July/001895.html Changed July 23, 2023])


== External Git Resources ==
== Resources ==


Links to useful external sites about Git
Links to useful external sites about Git
Line 37: Line 72:
=== Official Documentation ===
=== Official Documentation ===


* http://git-scm.com/documentation
* [http://git-scm.com/documentation Links to git official documentation]


=== Git for SVN Users ===
=== Git books ===


* http://git-scm.com/course/svn.html
* [http://progit.org/book/ Pro Git] - An easy to understand book on git (CC licensed).
 
* [http://book.git-scm.com/ The git community book], also as a [http://book.git-scm.com/book.pdf pdf]


=== Tutorials ===
=== Tutorials ===


=== Cheat Sheets ===
* [http://www-cs-students.stanford.edu/~blynn/gitmagic/ Git Magic] - A good intro to git (in several languages!)
 
*[http://tom.preston-werner.com/2009/05/19/the-git-parable.html The Git Parable]
 
* [http://try.github.io/ tryGit] A 15 minute online interactive tutorial
 
=== KDE's Git Infrastructure ===


* http://cheat.errtheblog.com/s/git
The [http://community.kde.org/Sysadmin/GitKdeOrgManual KDE Git System Administrators Manual] is a useful resource for more details on the technical implementation of the KDE Git infrastructure.


= Documentation Changes =
For more information on how the KDE Git Repositories are organized, please see the [[Guidelines_and_HOWTOs/Build_from_source|Build from source]] page.


== KDE Documentation Review ==
Other:
* The new [[Policies/Commit Policy|Commit Policy]] is being reviewed, applied to both SVN and Git.
* [[/GitHub Mirror/]] has been created and policy is in development (Sep 2015).


=== Existing Pages For Review ===
=== KDE Git Recipes ===


Existing KDE pages about Git, SVN, and/or building KDE that need to be revised.  When revising pages try to split the generic development and revision control policies separate from Git specific stuff.  Do not refer to "the KDE Git Repository" but instead the "KDE Code Repository".  Lots of small simple pages that are less daunting to newbies and can be linked to from multiple locations are preferred to massive walls of text.
Short recipes for using Git with the KDE infrastructure.


On community.kde.org:
Please see the [[Special:myLanguage/Infrastructure/Git/Recipes|Git Recipes page]].
* http://community.kde.org/Sysadmin/GitKdeOrgManual
* http://community.kde.org/20110213_GitWorkflowAgenda
* http://community.kde.org/20110213_GitWorkflowAgenda/StevesIdea


On techbase.kde.org:
=== KDE Git Tutorials ===
* [[Getting Started]]
* [[Getting Started/Build/KDE4]]
* [[Getting Started/Build/KDE4.x]]
* [[Getting Started/Build/KDE4/Prerequisites]]
* [[Getting Started/Build/KDE4/Windows/subversion]]
* [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts]]
* [[Getting_Started/Build/kdesrc-build]]
* [[Getting Started/Sources/Anonymous SVN]]
* [[Getting_Started/Sources/Using_Subversion_with_KDE]]
* [[Getting Started/Sources/Amarok Git Tutorial]]
* [[Getting_Started/Set_up_KDE_4_for_development]]
* [[Getting_Started/Using_an_IDE_with_KDE4]]
* [[Policies/SVN_Commit_Policy]]
* [[Policies/SVN_Guidelines]]
* [[Infrastructure/Tools]]
* [[Infrastructure/Tutorials/Git]]
* [[Infrastructure/Tutorials/Git/BestPractices]]
* [[Infrastructure/Tutorials/Git/Intermediate]]
* [[Infrastructure/Tutorials/Git/Recipes]]
* [[Infrastructure/Tutorials/Git/Create a patch]]
* [[Infrastructure/Tutorials/Git/git-svn]]
* [[Infrastructure/Tutorials/Git/Basics]]
* [[Infrastructure/Tutorials/Git/KdeOnGit]]
* [[Infrastructure/Tutorials/Git/kde-qt]]
* [[Infrastructure/Tutorials/Git/Pushing]]
* [[Infrastructure/Tutorials/Git/decoding-git]]
* [[Projects/rekonq/Git_with_rekonq_HowTo]]
* [[Projects/Related/Subversion]]
* [[Contribute/Get a SVN Account]]
* [[Contribute/First Steps with your KDE SVN Account]]


There are also numerous other pages referring to "the KDE SVN/subversion repositories" which should be replaced with the generic "KDE code repositories".
More in-depth instructions in using Git.


There are also numerous translated pages which will need to be updated once the original pages are completed.
* [[Special:myLanguage/Infrastructure/Tutorials/Git/GitQuickStart|A quick step-by-step guide for getting started]]


=== New Page Structure ===
* [[Special:myLanguage/Infrastructure/Tutorials/Git/Create a patch|Creating a patch]]


* [[Getting_Started]]
Please help filling this section by
* [[Getting_Started/Build]]
* checking the links at the bottom of the page and see which still have valid content
* [[Getting_Started/Build/Environment]]
* write tutorials yourself
* [[Getting_Started/Build/Requirements]]
* [[Getting_Started/Build/Qt]]
* [[Getting_Started/Build/KdeSupport]]
* [[Getting_Started/Build/Windows]]
* [[Getting_Started/Build/Mac_OS_X]]
* [[Getting_Started/Run]]
* [[Getting_Started/Run/Shell]]
* [[Getting_Started/Run/Nested_Session]]
* [[Getting_Started/Run/Full_Session]]


=== For Deletion ===
=== Cheat Sheets ===


The following pages can now be deleted and/or redirected:
* [[Media:Zrusin-git-cheat-sheet-medium.png|Illustrated git cheat sheet]]
* [http://techbase.kde.org/%5CKubuntu_10.04_qt-copy]
* [https://cheat.errtheblog.com/s/git Old quick reference]

Latest revision as of 11:52, 21 February 2024


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 https://invent.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.

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. Code changes should use the official KDE git repositories https://invent.kde.org/. And still, GitHub may be used / searched more intuitively than the alternatives. E.g. sign into github.com, then search for source code in the entire "KDE" organization with a URL such as https://github.com/search?q=org%3AKDE+KMessageBox Then click on "Code" or "Commits".

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 ~/.config/git/config. If your network blocks the Git protocol, then you can exchange that for HTTP instead.

[url "https://invent.kde.org/"]
    insteadOf = kde:
[url "[email protected]:"]
    pushInsteadOf = kde:

Once setup as above, you can clone and push to repositories through the URL kde:group/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 GitLab. Additionally, all mainline repositories are available on GitHub and can be browsed there. Please note that personal repositories are only browsable on our GitLab, they are not mirrored to GitHub.

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, such as images, 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. You can create personal repositories from the GitLab web interface. You can also "fork" an existing official KDE repository.

Personal repositories and forks 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 be created in the appropriate group on invent.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:

  • ED25519-256 (SHA256): zHdK2R/S6s5Oj71N0s8LHWCXXsUt+DCztd+GjzW9KlU
  • ECDSA-256 (SHA256): ZNBg4AkRxbt/N6xzpt7GbmmS78A3WFy5lz0l/cPHbcE
  • RSA-3072 (SHA256): KxAoV6VsbKvAocFZCJlxtmPDScmUCRNiUiOCSXNSC/k

(Changed July 23, 2023)

Resources

Links to useful external sites about Git

Official Documentation

Git books

  • Pro Git - An easy to understand book on git (CC licensed).

Tutorials

  • Git Magic - A good intro to git (in several languages!)
  • tryGit A 15 minute online interactive tutorial

KDE's Git Infrastructure

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 Build from source page.

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

Cheat Sheets