How to Deploy Community Modules on Odoo.sh (Odoo 16–19)

my-odoo-project/              ← GitHub repository root
├── my_custom_module/             ← custom module (detected automatically)
│   ├── __manifest__.py
│   ├── __init__.py
│   ├── models/
│   └── views/
├── my_other_module/              ← another custom module
│   └── __manifest__.py
├── OCA/                          ← OCA community modules (as git submodules)
│   ├── account-invoicing/        ← OCA repository submodule
│   │   └── account_invoice_xyz/  ← specific OCA module
│   └── partner-contact/
├── requirements.txt              ← Python package dependencies
└── .gitmodules                   ← git submodule registry (auto-managed)

# Step-by-step: first-time setup for a new Odoo.sh project

# 1. Create a GitHub repository for your project
#    (either a new repo or fork an existing one)

# 2. Clone locally and add your custom module
git clone https://github.com/your-org/your-odoo-project.git
cd your-odoo-project

# 3. Add your custom module directory
mkdir my_custom_module
# ... add __manifest__.py, __init__.py, models/, views/ etc.

# 4. Commit and push to the branch Odoo.sh is watching
git add .
git commit -m "feat: add my_custom_module"
git push origin main   # or 'master' depending on your default branch

# 5. In the Odoo.sh dashboard:
#    - Go to your project → Branches tab
#    - Your 'main' branch now appears as a Development branch
#    - Odoo.sh automatically starts a build
#    - Watch the build log in the Logs tab

# Adding an OCA module as a git submodule

# Example: add the OCA 'account-invoicing' repository
# (contains multiple modules — Odoo.sh will scan it and find them all)
git submodule add -b 17.0 https://github.com/OCA/account-invoicing.git OCA/account-invoicing

# This creates:
#  - OCA/account-invoicing/ directory (the submodule contents)
#  - .gitmodules file entry registering the submodule

# Commit both the submodule reference and .gitmodules
git add .gitmodules OCA/account-invoicing
git commit -m "feat: add OCA account-invoicing submodule (17.0)"
git push origin main

# Odoo.sh will automatically run 'git submodule update --init' during each build.
# You do NOT need to run any extra commands on the server.

# To update the submodule to the latest commit on its branch later:
git submodule update --remote OCA/account-invoicing
git add OCA/account-invoicing
git commit -m "chore: update OCA account-invoicing to latest 17.0"
git push origin main

# requirements.txt — place in the repository root

# Pin versions for reproducible builds
zeep==4.2.1          # SOAP client (e.g. for ZATCA integration)
cryptography==41.0.3  # for custom encryption utilities
pandas==2.1.0         # for data export/import modules
openpyxl==3.1.2       # Excel export

# OCA modules sometimes list their own requirements.txt files
# inside the module directory — Odoo.sh scans for and installs those too.
# Your repo root requirements.txt is additive.

# Safe deployment workflow for a new module

# 1. Develop on a feature branch (development branch in Odoo.sh)
git checkout -b feature/my-new-module
# ... develop, commit, push
git push origin feature/my-new-module
# Odoo.sh auto-builds on 'feature/my-new-module' as a development branch

# 2. Test on development branch
#    - Open Odoo.sh dashboard → feature/my-new-module → Connect (SSH or browser)
#    - Install the module: Apps → search for your module → Install
#    - Verify functionality with demo/test data

# 3. Merge to staging branch for pre-production testing
#    Option A: via GitHub pull request to 'staging' branch
#    Option B: via Odoo.sh dashboard → Staging tab → Merge branch
git checkout staging
git merge feature/my-new-module
git push origin staging
# Odoo.sh rebuilds staging with a copy of the production database
# The new module is NOT auto-installed — you must install it manually
# on the staging database to test the upgrade path

# 4. Verify on staging
#    - Module installs correctly on a production-data copy
#    - No data migration errors
#    - Emails are intercepted — safe to test workflows

# 5. Merge to production
git checkout main   # your production branch
git merge staging
git push origin main
# Odoo.sh applies the update in-place: runs module upgrade, restarts