Deploy custom code

erobinson · October 11, 2021, 9:08am

Is it possible to use the CCHQ Ansible scripts to deploy a modified code base? There are times when I see the need to (maybe temporarily) create a project space with access to custom reports perhaps not warranting a pull request. e.g. I may want to temporarily add entries to the domains section here:

github.com

dimagi/commcare-hq/blob/1a2c3bddbde5964c6ba9199632b29d96cd1bacf9/custom/inddex/ucr/data_sources/food_consumption_indicators.json

{
    "domains": [
        "senegal-arch-3-study",
        "inddex24-dev",
        "cambodia-arch-3-study",
        "iita-fcms-nigeria",
        "inddex-multilingual",
        "inddex-multi-vn",
        "inddex-reports",
        "inddex-reports-test"
    ],
    "server_environment": [
        "production",
        "localdev",
        "monolith"
    ],
    "config": {
        "engine_id": "ucr",
        "referenced_doc_type": "CommCareCase",
        "table_id": "food_consumption_indicators",

This file has been truncated. show original

...and an additional item to DOMAIN_MODULE_MAP here:

github.com

dimagi/commcare-hq/blob/a556a0586eb7029c83f3496366b1cbb78f7515a2/settings.py

#!/usr/bin/env python

import inspect
from collections import defaultdict
import importlib
import os

from django.contrib import messages
import settingshelper as helper

DEBUG = True

# clone http://github.com/dimagi/Vellum into submodules/formdesigner and use
# this to select various versions of Vellum source on the form designer page.
# Acceptable values:
# None - production mode
# "dev" - use raw vellum source (submodules/formdesigner/src)
# "dev-min" - use built/minified vellum (submodules/formdesigner/_build/src)
VELLUM_DEBUG = None

This file has been truncated. show original

Is there an easy way to go about that? Can I just edit the files after deploy and restart services to have them take effect?
Thanks!

Simon_Kelly · October 11, 2021, 10:23am

Hi Ed,

You could indeed edit the code in the current release and restart the services.

Alternately you can change the github repository used to deploy code. In fab-settings.yml you can set the following two values (values shown below are the defaults):

code_repo: 'https://github.com/dimagi/commcare-hq.git'
default_branch: master

erobinson · October 11, 2021, 11:14am

Brilliant, thanks Simon, that's helpful!