Mercurial > kallithea
view docs/dev/dbmigrations.rst @ 7633:1bafb2d07709 stable
hooks: make the Python interpreter for Git hooks configurable as 'git_hook_interpreter' (Issue #333)
Commit 5e501b6ee639 introduced the use of 'sys.executable' as interpreter
for git hooks instead of 'python2' with the following argument:
"Windows doesn't necessarily have "python2" available in $PATH, but we
still want to make sure we don't end up invoking a python3. Using the
absolute path seems more safe."
But, sys.executable does not necessarily point to Python. When Kallithea is
started under uWSGI, sys.executable points to the uwsgi executable. As a
result, the interpreter encoded in the git hooks on the server repositories
would be:
#!/path/to/uwsgi
And pushing to such repo would result in following client errors:
$ git push
Password for 'http://user@localhost:5050':
Enumerating objects: 3, done.
Counting objects: 100% (3/3), done.
Writing objects: 100% (3/3), 241 bytes | 241.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0)
remote: unable to load configuration from hooks/pre-receive
To http://localhost:5050/gitrepo-new
! [remote rejected] master -> master (pre-receive hook declined)
error: failed to push some refs to 'http://user@localhost:5050/gitrepo-new'
Fix this problem by introducing a configuration setting 'git_hook_interpreter'
that allow administrators to specify which Python interpreter to use.
A subsequent commit will cause its value to be filled in automatically when
generating a new ini file, but an administrator can always override it.
| author | Thomas De Schampheleire <thomas.de_schampheleire@nokia.com> |
|---|---|
| date | Mon, 08 Apr 2019 21:32:57 +0200 |
| parents | 3158cf0dafb7 |
| children |
line wrap: on
line source
======================= Database schema changes ======================= Kallithea uses Alembic for :ref:`database migrations <upgrade_db>` (upgrades and downgrades). If you are developing a Kallithea feature that requires database schema changes, you should make a matching Alembic database migration script: 1. :ref:`Create a Kallithea configuration and database <setup>` for testing the migration script, or use existing ``development.ini`` setup. Ensure that this database is up to date with the latest database schema *before* the changes you're currently developing. (Do not create the database while your new schema changes are applied.) 2. Create a separate throwaway configuration for iterating on the actual database changes:: kallithea-cli config-create temp.ini Edit the file to change database settings. SQLite is typically fine, but make sure to change the path to e.g. ``temp.db``, to avoid clobbering any existing database file. 3. Make your code changes (including database schema changes in ``db.py``). 4. After every database schema change, recreate the throwaway database to test the changes:: rm temp.db kallithea-cli db-create -c temp.ini --repos=/var/repos --user=doe --email doe@example.com --password=123456 --no-public-access --force-yes kallithea-cli repo-scan -c temp.ini 5. Once satisfied with the schema changes, auto-generate a draft Alembic script using the development database that has *not* been upgraded. (The generated script will upgrade the database to match the code.) :: alembic -c development.ini revision -m "area: add cool feature" --autogenerate 6. Edit the script to clean it up and fix any problems. Note that for changes that simply add columns, it may be appropriate to not remove them in the downgrade script (and instead do nothing), to avoid the loss of data. Unknown columns will simply be ignored by Kallithea versions predating your changes. 7. Run ``alembic -c development.ini upgrade head`` to apply changes to the (non-throwaway) database, and test the upgrade script. Also test downgrades. The included ``development.ini`` has full SQL logging enabled. If you're using another configuration file, you may want to enable it by setting ``level = DEBUG`` in section ``[handler_console_sql]``. The Alembic migration script should be committed in the same revision as the database schema (``db.py``) changes. See the `Alembic documentation`__ for more information, in particular the tutorial and the section about auto-generating migration scripts. .. __: http://alembic.zzzcomputing.com/en/latest/ Troubleshooting --------------- * If ``alembic --autogenerate`` responds "Target database is not up to date", you need to either first use Alembic to upgrade the database to the most recent version (before your changes), or recreate the database from scratch (without your schema changes applied).