Sysadmin/GitKdeOrgManual
Overview of facilities
- Invent (invent.kde.org)
- Patch review (account sign-up via KDE Identity), repository browser and other services.
- commits.kde.org
- Provides Git commit "short URLs", redirecting to the repository browser pages as appropriate (example).
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.
- KDE Projects (projects.kde.org)
- Central project hub and primary repository browser.
- Replaced by: the sysadmin/repo-metadata repository (metadata information); phabricator.kde.org (browser)
- 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.
- Repository browser. It shows also personal clones of project repositories and personal scratch repositories (see below),.
- Phabricator (phabricator.kde.org)
- 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.
Information For KDE Developers
For general information visit the page about the use of Git by KDE.
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:
[url "https://invent.kde.org/"] insteadOf = kde: [url "ssh://[email protected]/"] pushInsteadOf = kde:
Then, to clone e. g. the Amarok repo, just do
$ git clone kde:multimedia/amarok.git
By using the kde: prefix, read access will automatically happen over HTTPS, and authenticated SSH is only required for pushes.
Commit hook keywords
See Special keywords in GIT and SVN log messages
Personal repositories
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.
See mastering git filter-branch: points to extract a subproject for more helpful hints.