← Sysadmin/GitKdeOrgManual You do not have permission to edit this page, for the following reason: The action you have requested is limited to users in one of the groups: Users, Administrators, trusted, KDEDevelopers. You can view and copy the source of this page. [[File:Mascot konqi-app-system.png|thumbnail|right|[[Konqi]] and the gears.]] == Overview of facilities == * '''[http://identity.kde.org/ KDE Identity]''' (identity.kde.org) :Account management; notably managing your SSH public keys for read-write developer access. * '''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. * '''[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]]),. * '''[http://phabricator.kde.org/ Phabricator]''' (phabricator.kde.org) :Patch review (account sign-up via [http://identity.kde.org/ KDE Identity]). [[Infrastructure/Phabricator|Phabricator]], repository browser, calendar and other services. * '''commits.kde.org''' :Provides Git commit "short URLs", redirecting to the repository browser pages as appropriate ([http://commits.kde.org/324dd0cd/a8d1175f61e678f61b3643c867f212ad26ce6f44 example]). === Discontinued services === The following services have been discontinued. Usually their role is now provided by other systems. They are listed here for reference as they may still be referenced in older documentation. * '''[http://projects.kde.org/ 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) * '''[http://commitfilter.kde.org commitfilter.kde.org]''' :Sends an email with each commit for the projects you want to watch. == How to get read-write developer access == 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. == Information For KDE Developers == For general information visit the page about [[Infrastructure/Git | the use of Git by KDE]]. To configure Git for your KDE Development environment, please see the [http://techbase.kde.org/Development/Git/Configuration KDE Git Configuration] page on TechBase. 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. == Overview of repository URL schemes == === URL prefixes === Anonymous read-only access uses the following URL prefix: git://anongit.kde.org/ Read-write developer access uses this prefix instead: firstname.lastname@example.org: === Repository paths === Following the prefix, here are the path schemes for different types of repositories: * '''<project identifier>''' :A KDE project repository, be it part of the KDE SC, KDE Extragear or KDE Playground. * '''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]]). === Let Git rewrite URL prefixes === Instead of remembering the above URL prefixes, you can also put the following in your <tt>~/.gitconfig</tt>: [url "https://anongit.kde.org/"] insteadOf = kde: [url "email@example.com:"] pushInsteadOf = kde: Then, to clone e. g. the Amarok repo, just do $ git clone kde:amarok By using the <tt>kde:</tt> prefix, read access will automatically happen over Git, and authenticated SSH is only required for pushes. Since commits are mirrored to anongit right when you push them, you will not have to worry about anongit being outdated. When using invent.kde.org you'll want to use a different hostname instead: [url "https://invent.kde.org/kde/"] insteadOf = invent: [url "firstname.lastname@example.org:kde/"] pushInsteadOf = invent: == Server-side commands == git.kde.org understands several server-side commands that can be used on the command line via SSH in this fashion: ssh email@example.com <command> [parameters] To simplify the first argument to "kde" (i.e. "<tt>ssh kde <command> [parameters]</tt>"), put the following in ~/.ssh/config: Host kde HostName git.kde.org User git The following is a list of the commands that are currently available, broadly divided into categories according to their purpose. ===Commands for information retrieval=== *'''<span id="info">info</span>''' <small>[[#info|(link here)]]</small> :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. *'''<span id="expand">expand [regex]</span>''' <small>[[#expand|(link here)]]</small> :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. *'''<span id="who-pushed">who-pushed <repository path> <commit sha1 hash></span>''' <small>[[#who-pushed|(link here)]]</small> :Shows the KDE Identity user name of the contributor who pushed the specified commit to the specified repository. ===Commands to manage personal repositories=== *'''<span id="clone">clone <path to source repository> <clone name></span>''' <small>[[#clone|(link here)]]</small> :Can be used to make a personal clone of a project repository. :An example: ssh firstname.lastname@example.org clone konversation mykonvi :This results in a clone at <tt>clones/konversation/<your KDE Identity user name>/mykonvi</tt>. :A second example with a longer source repository path: ssh email@example.com clone websites/projects-kde-org newtheme :This results in a clone at <tt>clones/websites/projects-kde-org/<your KDE Identity user name>/newtheme</tt>. :More on personal clones [[#Personal repositories|here]]. *'''<span id="rm">D rm <repository path></span>''' <small>[[#destroy|(link here)]]</small> :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. See also the <tt>[[#trash|D trash]]</tt> command as an alternative to outright and irrevocable deletion. *'''<span id="lock">D lock <repository path></span>''' <small>[[#lock|(link here)]]</small> :Locks a repository, causing the <tt>[[#destroy|rm]]</tt> command to deny deleting it. :Newly-created repositories are locked by default. *'''<span id="unlock">D unlock <repository path></span>''' <small>[[#unlock|(link here)]]</small> :Unlocks a repository, making it possible to delete it using the <tt>[[#destroy|rm]]</tt> command. ====Commands to manage the personal trash area==== *'''<span id="trash">D trash <repository path></span>''' <small>[[#trash|(link here)]]</small> :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">D 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. *'''<span id="list-trash">D list-trash</span>''' <small>[[#list-trash|(link here)]]</small> :Lists all entries in the personal trash area, in the form <tt><repository path>/<timestamp></tt>. ===Commands related to repository importing=== *'''<span id="hooks-enable">hooks enable <project repository path></span>''' <small>[[#hooks-enable|(link here)]]</small> :An example: ssh firstname.lastname@example.org hooks enable konversation :Available only to repository and system administrators, this command enables several hook scripts that git.kde.org will then execute during a push operation to the specified project repository. Importantly, it also enables write access for non-administrators, which is otherwise disabled along with the hooks scripts. :The hook scripts in question are the ones reponsible for forwarding commits to the [https://mail.kde.org/mailman/listinfo/kde-commits kde-commits] mailing list and [http://www.cia.vc/ CIA.vc], and for processing commit message keywords (BUG, CCMAIL, etc.) that may interact with [http://bugs.kde.org/ KDE Bugzilla] or cause further emails to be sent. As these hook scripts are only available to project repositories, and not to [[#Personal repositories|personal repositories]], the command only applies to them. :After creating a new, empty project repository for you the system administators will initially disable the hook scripts so you can safely import large numbers of old commits. ===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. *'''<span id="able">able <en|dis> <@all|repository path></span>''' <small>[[#able|(link here)]]</small> :Used by system administrators to enable or disable writes to particular repositories or all repositories, for maintenance. *'''<span id="hooks-disable">hooks disable <project repository path></span>''' <small>[[#hooks-disable|(link here)]]</small> :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. *'''<span id="ohnoes">ohnoes <show|recover> <repository path> <gitref></span>''' <small>[[#ohnoes|(link here)]]</small> :Used by system administrators to recover deleted branches or mistaken force pushes (rewinds). == Commit hook keywords == See [[Policies/Commit_Policy#Special_keywords_in_GIT_and_SVN_log_messages | Special keywords in GIT and SVN log messages]] == Personal repositories == git.kde.org currently offers two types of personal repositories: Personal clones of project repositories and personal scratch 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: ssh email@example.com 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 [https://cgit.kde.org/ cgit.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 <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. For the rest of this instruction, let's assume the following names: * <kde-id> - Your KDE identity user name * <repo> - Your (new) git repository name If you start a new project then you need to create a git repository out of it before you start to push it to the scratch repositories. This is done by going into the the directory which will contain your project and type: git init This will convert the local directory to a git repository. This is of course not necessary if you already have a local git repo containing your project. To make pushing to the repository convenient, it is recommended to add a remote to push to first: git remote add origin firstname.lastname@example.org:scratch/<kde-id>/<repo> Now you need to create something to push. Otherwise git will refuse the next step. So it is recommended that you create a README for your project and then commit that. If you are copying in an existing (non-git) project, you should 'git add . && git commit -a' first. Afterward, you perform the first push to the repository as follows: git push --all origin Now your new scratch repository is created and initialized. It will take about 30 minutes until the creation of the new repository has propagated to the other tools and is visible there. git push --all does not push tags. You can push them in a second step with git push --tags ...as above... Personal scratch repositories can be browsed on [https://cgit.kde.org/ cgit.kde.org]. You can set a description on your scratch repository by issuing a command ssh email@example.com desc scratch/<kde-id>/<repo> "Application to do magic" 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], and [http://www.englishbreakfastnetwork.org/ EBN], 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://sysadmin.kde.org/tickets/index.php?page=tickets&act=add sysadmin repo 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>[[#rm|rm]]</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. ssh firstname.lastname@example.org D trash scratch/<username>/<project> '''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. == Requesting project migrations from KDE SVN or Gitorious.org == To get your project moved from KDE SVN or Gitorious.org to git.kde.org, you have to file a [http://sysadmin.kde.org/svnaccount/repo-request.php sysadmin request]. It will ask you for the following information: * The name and description of the project. * 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://phabricator.kde.org Phabricator] 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. (When converting from KDE svn to git this typically involves [[../DeveloperAccessForRuleWriting|writing a rule set]], running svn-all-fast-export, and then pushing the created repository into the new git path.) 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. == 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 <tt>git reset --hard <original-branch></tt> 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 <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. 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). :<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. === Filtering === <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). A combination of <tt>--tree-filter</tt>, <tt>--prune-empty</tt> and <tt>--msg-filter</tt> 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 <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>!) 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. See [http://whileimautomaton.net/2010/04/03012432 mastering git filter-branch: points to extract a subproject] for more helpful hints. Return to Sysadmin/GitKdeOrgManual. Retrieved from "https://community.kde.org/Sysadmin/GitKdeOrgManual"