Files
@ a8b407f29405
Branch filter:
Location: kallithea/docs/usage/customization.rst - annotation
a8b407f29405
2.9 KiB
text/prs.fallenstein.rst
controllers: don’t pass start=0 to BaseRepository.get_changesets()
MercurialRepository.get_changesets() can fail if passing start=0 if the
revision 0 is not in self.revisions. That can happen if revision 0 is not in
the visible subset of the revisions in the repository. Before Kallithea
changeset 7c43e15fb8bc7a73f17f577e59a4698589b6809d, it was working by chance
because start=0 was treated like start=None in the relevant places
(GitRepository.get_changesets still does that).
The intention of passing start=0 was seemingly to not limit the start.
Therefore passing start=None (or nothing, as it’s the default value) should be
correct.
I got the following traceback before this change:
Traceback (most recent call last):
File "~/vcs/kallithea/kallithea/controllers/changelog.py", line 117, in index
collection = c.db_repo_scm_instance.get_changesets(start=0, end=revision,
File "~/vcs/kallithea/kallithea/lib/vcs/backends/hg/repository.py", line 529, in get_changesets
start_pos = None if start is None else self.revisions.index(start_raw_id)
ValueError: '4257f758b3eaacaebb6956d1aefc019afab956b8' is not in list
MercurialRepository.get_changesets() can fail if passing start=0 if the
revision 0 is not in self.revisions. That can happen if revision 0 is not in
the visible subset of the revisions in the repository. Before Kallithea
changeset 7c43e15fb8bc7a73f17f577e59a4698589b6809d, it was working by chance
because start=0 was treated like start=None in the relevant places
(GitRepository.get_changesets still does that).
The intention of passing start=0 was seemingly to not limit the start.
Therefore passing start=None (or nothing, as it’s the default value) should be
correct.
I got the following traceback before this change:
Traceback (most recent call last):
File "~/vcs/kallithea/kallithea/controllers/changelog.py", line 117, in index
collection = c.db_repo_scm_instance.get_changesets(start=0, end=revision,
File "~/vcs/kallithea/kallithea/lib/vcs/backends/hg/repository.py", line 529, in get_changesets
start_pos = None if start is None else self.revisions.index(start_raw_id)
ValueError: '4257f758b3eaacaebb6956d1aefc019afab956b8' is not in list
60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 8152f9e6a778 8152f9e6a778 8152f9e6a778 8152f9e6a778 8152f9e6a778 3b54bcf6d128 3b54bcf6d128 3b54bcf6d128 3b54bcf6d128 3b54bcf6d128 8152f9e6a778 b66725ba01ed b66725ba01ed 8152f9e6a778 b66725ba01ed 8152f9e6a778 8152f9e6a778 8152f9e6a778 8152f9e6a778 8152f9e6a778 8152f9e6a778 e3d8f4bc3ce7 e3d8f4bc3ce7 60f9840c8df1 e3d8f4bc3ce7 e3d8f4bc3ce7 e3d8f4bc3ce7 60f9840c8df1 e3d8f4bc3ce7 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 f9c8fec48185 60f9840c8df1 e3d8f4bc3ce7 e3d8f4bc3ce7 e3d8f4bc3ce7 e3d8f4bc3ce7 e3d8f4bc3ce7 e3d8f4bc3ce7 e3d8f4bc3ce7 e3d8f4bc3ce7 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 | .. _customization:
=============
Customization
=============
There are several ways to customize Kallithea to your needs depending on what
you want to achieve.
HTML/JavaScript/CSS customization
---------------------------------
To customize the look-and-feel of the web interface (for example to add a
company banner or some JavaScript widget or to tweak the CSS style definitions)
you can enter HTML code (possibly with JavaScript and/or CSS) directly via the
*Admin > Settings > Global > HTML/JavaScript customization
block*.
Style sheet customization with Less
-----------------------------------
Kallithea uses `Bootstrap 3`_ and Less_ for its style definitions. If you want
to make some customizations, we recommend to do so by creating a ``theme.less``
file. When you create a file named ``theme.less`` in directory
``kallithea/front-end/`` inside the Kallithea installation, you can use this
file to override the default style. For example, you can use this to override
``@kallithea-theme-main-color``, ``@kallithea-logo-url`` or other `Bootstrap
variables`_.
After creating the ``theme.less`` file, you need to regenerate the CSS files, by
running::
kallithea-cli front-end-build --no-install-deps
.. _bootstrap 3: https://getbootstrap.com/docs/3.3/
.. _bootstrap variables: https://getbootstrap.com/docs/3.3/customize/#less-variables
.. _less: http://lesscss.org/
Behavioral customization: Kallithea extensions
----------------------------------------------
Some behavioral customization can be done in Python using Kallithea
``extensions``, a custom Python file you can create to extend Kallithea
functionality.
With ``extensions`` it's possible to add additional mappings for Whoosh
indexing and statistics, to add additional code into the push/pull/create/delete
repository hooks (for example to send signals to build bots such as Jenkins) and
even to monkey-patch certain parts of the Kallithea source code (for example
overwrite an entire function, change a global variable, ...).
To generate a skeleton extensions package, run::
kallithea-cli extensions-create -c my.ini
This will create an ``extensions.py`` file next to the specified ``ini`` file.
You can find more details inside this file.
For compatibility with previous releases of Kallithea, a directory named
``rcextensions`` with a file ``__init__.py`` inside of it can also be used. If
both an ``extensions.py`` file and an ``rcextensions`` directory are found, only
``extensions.py`` will be loaded. Note that the name ``rcextensions`` is
deprecated and support for it will be removed in a future release.
Behavioral customization: code changes
--------------------------------------
As Kallithea is open-source software, you can make any changes you like directly
in the source code.
We encourage you to send generic improvements back to the
community so that Kallithea can become better. See :ref:`contributing` for more
details.
|