GitHub Actions - Odoo Quality Workflows

Central repository for reusable GitHub Actions workflows for Odoo addon development.

Organization: much-GmbH-sandbox (sandbox for testing)

Getting Started

New Repository (Recommended)

Use base-template as a template:

1. Click "Use this template" on the base-template page
2. Create your new repository
3. Update pyproject.toml with your Odoo version
4. Copy the appropriate .pylintrc for your version

base-template includes:

• CI workflow using these centralized workflows
• All linter configs (.flake8, .bandit, .pylintrc)
• Pre-commit hooks configuration
• Editor and Git configs

Existing Repository

Add the CI workflow to .github/workflows/ci.yml:

name: CI

on:
  push:
    branches: [main, staging]
  pull_request:

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  quality:
    uses: much-GmbH-sandbox/github-actions/.github/workflows/odoo-quality.yml@v1
    with:
      odoo-version: '17'  # Change to your Odoo version
    secrets: inherit

  tests:
    needs: [quality]
    uses: much-GmbH-sandbox/github-actions/.github/workflows/odoo-tests.yml@v1
    with:
      odoo-version: '17'
    secrets: inherit

Then copy config files from base-template.

Workflows

odoo-quality.yml - Quality Checks

Consolidated quality checks running all tools in a single job (cost-optimized).

Tools included:

Tool	Purpose
Dependencies	Check for unreleased dependencies
Black	Code formatting
Flake8	Python linting
Pylint-Odoo	Odoo-specific linting
Radon	Cyclomatic complexity
Bandit	Security scanning
SonarQube	Code quality analysis (optional)

Inputs:

Input	Required	Default	Description
odoo-version	Yes	-	Odoo version (14, 15, 16, 17, 18)
python-version	No	3.10	Python version
skip-sonar	No	false	Skip SonarQube analysis
strict-mode	No	false	Fail on any check failure

Secrets (optional):

• SONAR_TOKEN - SonarQube authentication token
• SONAR_HOST_URL - SonarQube server URL

odoo-tests.yml - Unit Tests

Runs Odoo unit tests using odoo-docker-minimal with Docker Compose.

Features:

• Automatically discovers test modules (files containing test tags)
• For PRs, only tests modules that were changed (dependencies auto-installed by Odoo)
• For pushes, runs all tests
• Git submodules always included
• Repository dependencies cloned from GitHub (see Repository Dependencies)
• Posts test results as PR comments
• Respects test_enabled setting in pyproject.toml

Inputs:

Input	Required	Default	Description
odoo-version	Yes	-	Odoo version (14, 15, 16, 17, 18)
test-tags	No	much_unit	Test tags to run
strict-mode	No	false	Fail on any test failure
timeout-minutes	No	30	Test execution timeout
skip-dependencies	No	false	Skip cloning repository dependencies

Secrets (required for enterprise testing):

• REGISTRY_URL - Docker registry URL
• REGISTRY_USER - Docker registry username
• REGISTRY_PASSWORD - Docker registry password
• ENTERPRISE_TOKEN - Token for downloading enterprise modules
• DOCKER_MINIMAL_TOKEN - PAT for accessing odoo-docker-minimal repo

Outputs:

• tests-passed - Whether all tests passed (true/false)
• modules-tested - Comma-separated list of tested modules

Repository Structure

github-actions/
├── .github/
│   ├── workflows/
│   │   ├── odoo-quality.yml      # Quality checks workflow
│   │   └── odoo-tests.yml        # Unit tests workflow
│   └── docs/
│       └── PRE_COMMIT.md         # Pre-commit setup guide
├── dev-requirements/
│   ├── base.txt                  # Core tools
│   └── odoo{14-18}.txt           # Version-specific tools
├── base-template/                # Template for new Odoo addons
└── README.md

Note: Linter configs (.flake8, .bandit, .pylintrc) are in base-template.

Supported Odoo Versions

Odoo Version	Python Versions	Pylint-Odoo
14	3.6, 3.8	7.0.0
15	3.8, 3.10	8.0.0
16	3.8, 3.10	8.0.0
17	3.10, 3.11	9.3.7
18	3.10, 3.11, 3.12	9.3.7
19	3.10, 3.11, 3.12	9.3.7

Repository Dependencies

When your Odoo addon depends on modules from other repositories, configure them in pyproject.toml. The CI workflow will automatically clone these dependencies before running tests.

Configuration

Add an [odoo.dependencies] section to your pyproject.toml:

[odoo.dependencies]
# Format: "org/repo" = "version_strategy"
#
# Version strategies:
#   "tag"    - Find latest tag matching v{odoo-major}.* (DEFAULT)
#   "branch" - Clone the {odoo-major}.0 branch
#   "X.Y.Z"  - Explicit branch/tag name
#
"much-GmbH/much-integration-hub" = "tag"
"much-GmbH/much-notify" = "tag"

Version Resolution

Strategy	Example	Resolves to (Odoo 17)
"tag"	"much-GmbH/much-notify" = "tag"	Latest v17.* tag (e.g., v17.0.1.0.0)
"branch"	"much-GmbH/much-notify" = "branch"	Branch 17.0
Explicit	"much-GmbH/much-notify" = "v17.0.0.1.0"	Exact tag/branch v17.0.0.1.0

Important Notes

• Dependencies are explicit - If your addon depends on ihub, and ihub depends on much-notify, you must list both:

  [odoo.dependencies]
  "much-GmbH/much-integration-hub" = "tag"
  "much-GmbH/much-notify" = "tag"  # Required by ihub

• Caching - Dependencies are cached based on pyproject.toml hash. Changes to the file invalidate the cache.
• Private repos - Requires CONFIG_TOKEN secret with read access to the dependency repositories.
• Skip dependencies - Use skip-dependencies: true input to disable dependency cloning.

Example: much-datev-integration

[odoo]
version = 17.0
edition = "enterprise"

[odoo.testing]
enabled = true
test_tags = "much_unit"

[odoo.dependencies]
# ihub modules (ihub, ihub_log, ihub_job, ihub_queue)
"much-GmbH/much-integration-hub" = "tag"
# Required by ihub_queue
"much-GmbH/much-notify" = "tag"

Troubleshooting

Issue	Cause	Solution
No tag matching v17.* found	No version tags for this Odoo version	Use "branch" strategy or explicit version
Failed to clone	Missing access or invalid ref	Check CONFIG_TOKEN permissions and ref exists
Tests fail with missing module	Dependency not listed	Add missing transitive dependencies

Cost Optimization

This workflow uses a single consolidated job instead of parallel jobs.

Why? GitHub bills each job rounded up to the nearest minute:

• 5 parallel 30-second jobs = 5 minutes billed
• 1 sequential 3.5-minute job = 4 minutes billed

This saves 20-40% on GitHub Actions minutes.

Secrets Configuration

Organization-Level (Recommended)

gh secret set SONAR_TOKEN --org much-GmbH-sandbox --visibility private
gh secret set SONAR_HOST_URL --org much-GmbH-sandbox --visibility private

Repository-Level

gh secret set SONAR_TOKEN -R much-GmbH-sandbox/my-addon

Versioning

Use version tags for stability. Never use @main in production.

# Major version (recommended)
uses: much-GmbH-sandbox/github-actions/.github/workflows/odoo-quality.yml@v1

# Exact version (most stable)
uses: much-GmbH-sandbox/github-actions/.github/workflows/odoo-quality.yml@v1.0.0

Code Formatting

Format your code locally before committing using pre-commit hooks.

pip install pre-commit
pre-commit install

See the Pre-commit Setup Guide or base-template for config files.

Related Repositories

• base-template - Template with linter configs and CI workflow