kallithea Files · docs/usage/locking.rst

Files @ 4b241f198cf2

Branch filter:

Location: kallithea/docs/usage/locking.rst

4b241f198cf2 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

.coveragerc: fix reporting of coverage to match what is run

Without this change, the HTML report will show all lines specified in
run.omit. As they have 0% coverage, this will negatively impact the overall
coverage percentage calculated in the report.

Note: at this moment, we have an overall 74% test coverage.
Test by installing pytest-cov and running:
py.test --cov=kallithea --cov-config=.coveragerc --cov-report html
and opening htmlcov/index.html in a browser.

.. _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.