Browse Source

Zrušení dvojteček

pull/11/head
Pavel "LEdoian" Turinsky 2 years ago
parent
commit
61bb9786b3
  1. 42
      docs/skripty.rst

42
docs/skripty.rst

@ -45,61 +45,61 @@ Proměnné
Popsány jsou jen užitečné proměnné, ve skutečnosti jich je definovaných víc, Popsány jsou jen užitečné proměnné, ve skutečnosti jich je definovaných víc,
ale jsou triviální a samopopisné. ale jsou triviální a samopopisné.
``VENV_PATH`` : ``VENV_PATH``
Cesta virtuálního prostředí. Též lze přepsat. Cesta virtuálního prostředí. Též lze přepsat.
``REPO`` : ``REPO``
Cesta ke gitovému repozitáři na serveru, rovnou použitelná v ``git clone`` Cesta ke gitovému repozitáři na serveru, rovnou použitelná v ``git clone``
``GIMLI_LOGIN`` : ``GIMLI_LOGIN``
Přihlašovací údaje ke Gimlimu Přihlašovací údaje ke Gimlimu
``PRODWEB`` a ``TESTWEB`` : ``PRODWEB`` a ``TESTWEB``
Cesty ke složkám s produkčním a testovacím webem Cesty ke složkám s produkčním a testovacím webem
Funkce a další zkratky Funkce a další zkratky
"""""" """"""
``ensure_venv`` : ``ensure_venv``
Zajistí, že se zbytek skriptu spustí ve virtuálním prostředí, a pokud neexistuje, tak jej založí. Zajistí, že se zbytek skriptu spustí ve virtuálním prostředí, a pokud neexistuje, tak jej založí.
``ensure_web_installed`` : ``ensure_web_installed``
Vyzkouší, že je web (django) aspoň elementárně zprovozněno a pokud ne, tak vyzve uživatele, aby to spravil. Vyzkouší, že je web (django) aspoň elementárně zprovozněno a pokud ne, tak vyzve uživatele, aby to spravil.
``gimli_only`` : ``gimli_only``
Otestuje, že je příkaz spuštěn na Gimlim, pokud tomu tak není, zeptá se, jestli si uživatel skutečně přeje zbytek skriptu vykonat Otestuje, že je příkaz spuštěn na Gimlim, pokud tomu tak není, zeptá se, jestli si uživatel skutečně přeje zbytek skriptu vykonat
``only_in_directory <složka>`` : ``only_in_directory <složka>``
Otestuje, že skript běží z konkrétní složky. Zejména použitelné s ``gimli_only`` a ``$TESTWEB`` Otestuje, že skript běží z konkrétní složky. Zejména použitelné s ``gimli_only`` a ``$TESTWEB``
``safe_checkout_branch <větev>`` : ``safe_checkout_branch <větev>``
Bezpečně přepne repozitář na jinou větev. Pokud by mělo dojít k přepsání Bezpečně přepne repozitář na jinou větev. Pokud by mělo dojít k přepsání
knihovny nebo volajícího make skriptu, vyzve uživatele, aby přepnul ručně. knihovny nebo volajícího make skriptu, vyzve uživatele, aby přepnul ručně.
``install_everything`` : ``install_everything``
Společná část kódu pro nasazování produkce a testwebu. Společná část kódu pro nasazování produkce a testwebu.
Skripty pro lokální vývoj Skripty pro lokální vývoj
^^^^^^^ ^^^^^^^
``make/install_web`` (nebo ekvivalentně ``make/install``) : ``make/install_web`` (nebo ekvivalentně ``make/install``)
Vytvoří virtualenv a nainstaluje do něj závislosti webu podle ``requirements.txt``. Následně popíše, jak vyrobit zbytek lokálního webu. Vytvoří virtualenv a nainstaluje do něj závislosti webu podle ``requirements.txt``. Následně popíše, jak vyrobit zbytek lokálního webu.
``make/run`` : ``make/run``
Spustí lokální web (ekvivalentní s ``./manage.py runserver``) Spustí lokální web (ekvivalentní s ``./manage.py runserver``)
``make/schema`` : ``make/schema``
Vykreslí závislosti a atributy modelů Vykreslí závislosti a atributy modelů
``make/sync_prod_flatpages`` : ``make/sync_prod_flatpages``
Stáhne z produkce aktuální statické stránky a uloží je do složky ``data/`` Stáhne z produkce aktuální statické stránky a uloží je do složky ``data/``
``make/test`` : ``make/test``
Spustí testy (ekvivalentní s ``./manage.py test -v2``) Spustí testy (ekvivalentní s ``./manage.py test -v2``)
``make/init_local`` : ``make/init_local``
Zkratka za posloupnost ``make/install_web``, ``./manage.py testdata``, ``./manage.py loaddata data/*``, ``make/sync_prod_flatpages`` Zkratka za posloupnost ``make/install_web``, ``./manage.py testdata``, ``./manage.py loaddata data/*``, ``make/sync_prod_flatpages``
Práce s testwebem Práce s testwebem
^^^^^^^ ^^^^^^^
``make/deploy`` : ``make/deploy``
Nasadí testweb. Volitelně bere jako parametr jméno větve, kterou má nasadit. Nasadí testweb. Volitelně bere jako parametr jméno větve, kterou má nasadit.
Rovnou nastaví přihlašování a vygeneruje příslušnou verzi dokumentace `sem <https://mam-test.ks.matfyz.cz/docs>`_. Rovnou nastaví přihlašování a vygeneruje příslušnou verzi dokumentace `sem <https://mam-test.ks.matfyz.cz/docs>`_.
``make/push_compiled_vue_to_test`` : ``make/push_compiled_vue_to_test``
**Neotestováno** Nahraje Vue z lokálního počítače na testweb. (Gimli často má moc starou verzi Node.js, takže nejde zkompilovat tam) **Neotestováno** Nahraje Vue z lokálního počítače na testweb. (Gimli často má moc starou verzi Node.js, takže nejde zkompilovat tam)
``make/sync_test_db_aggressive`` : ``make/sync_test_db_aggressive``
Zkopíruje databázi z produkčního webu. Zkopíruje databázi z produkčního webu.
``make/sync_test_media`` : ``make/sync_test_media``
Zkopíruje média (obrázky, nahrané soubory) z produkčního webu. Zkopíruje média (obrázky, nahrané soubory) z produkčního webu.
``make/sync_test`` : ``make/sync_test``
Zkratka za ``make/sync_test_db_aggressive`` + ``make/sync_test_media``. Zkratka za ``make/sync_test_db_aggressive`` + ``make/sync_test_media``.
Nasazení produkce Nasazení produkce

Loading…
Cancel
Save