kallithea Files · docs/usage/locking.rst

Files @ 588c556aa00b

Branch filter:

Location: kallithea/docs/usage/locking.rst

588c556aa00b 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Søren Løvborg

comments: for PR comments, link directly to comment on PR page

Comments with approval changes made in the context of PRs also show up
on the individual PR changesets, and currently link to the (top of the)
PR page. If the user wants to see the surrounding comments, it can be
difficult to find the comment.

This change makes the link go to the comment anchor on the PR page, so
the user immediately sees the relevant comment thread. The PR metadata
is still readily available (by scrolling up or pressing "Home").

.. _locking:

==================
Repository locking
==================

Kallithea has a *repository locking* feature, disabled by default. When
enabled, every initial clone and every pull gives users (with write permission)
the exclusive right to do a push.

When repository locking is enabled, repositories get a ``locked`` flag.
The hg/git commands ``hg/git clone``, ``hg/git pull``,
and ``hg/git push`` influence this state:

- A ``clone`` or ``pull`` action locks the target repository
  if the user has write/admin permissions on this repository.

- Kallithea will remember the user who locked the repository so only this
  specific user can unlock the repo by performing a ``push``
  command.

- Every other command on a locked repository from this user and every command
  from any other user will result in an HTTP return code 423 (Locked).
  Additionally, the HTTP error will mention the user that locked the repository
  (e.g., “repository <repo> locked by user <user>”).

Each repository can be manually unlocked by an administrator from the
repository settings menu.