odoo-devkit/.github/github.json at main · cbusillo/odoo-devkit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
{
  "defaultBranch": "main",
  "projectType": "odoo-workspace-devkit",
  "docs": {
    "index": "docs/README.md",
    "overview": "README.md",
    "architecture": "docs/ARCHITECTURE.md",
    "roles": "docs/roles.md",
    "workspaceCli": "docs/tooling/workspace-cli.md",
    "artifactInputs": "docs/tooling/artifact-inputs.md",
    "buildToolUpgrades": "docs/tooling/build-tool-upgrades.md",
    "commandPatterns": "docs/tooling/command-patterns.md",
    "tenantOverlay": "docs/tooling/tenant-overlay.md",
    "pythonInspection": "docs/tooling/python-inspection.md",
    "styleChecks": "docs/tooling/style-checks.md",
    "addonCi": "docs/tooling/addon-ci.md",
    "consumerBuildChecks": "docs/tooling/consumer-build-checks.md"
  },
  "qualityGate": {
    "setup": {
      "default": "uv sync --locked"
    },
    "test": {
      "local": "uv run python -m unittest discover -s tests -p '{test_file}'",
      "ci": "uv run python -m unittest discover -s tests",
      "runtimePythonLock": "uv lock --check --offline --no-config --project docker/runtime-python",
      "addonCiLock": "uv lock --check --offline --no-config --project docker/addon-tests",
      "liveOdoo": "uv run python -m odoo_devkit.addon_ci --image <community-devtools-image> --odoo-version <selected-odoo-series> --addons-root tests/live_odoo/addons --support-root <sparse-shared-addons-checkout> --devkit-checks --output <task-evidence-directory>"
    },
    "format": {
      "default": "uv run ruff format --check ."
    },
    "lint": {
      "default": "uv run ruff check ."
    },
    "build": {
      "package": "uv build"
    },
    "smoke": {
      "cli": "uv run platform --help",
      "sourceValidation": "uv run platform workspace check-source --manifest <tenant-workspace.toml>",
      "workspaceSurface": "uv run platform workspace sync --manifest <proof-workspace.toml>"
    },
    "inspection": {
      "ide": "PyCharm",
      "scopePreference": "changed_files",
      "prepare": {
        "python": {
          "version": "3.13",
          "moduleName": "odoo-devkit",
          "testRoots": [
            "tests"
          ],
          "sync": true,
          "requiredGeneratedState": [
            ".venv",
            ".idea"
          ]
        }
      }
    },
    "docsRequiredWhen": [
      "behavior changes",
      "api changes",
      "config changes",
      "operations changes",
      "ownership boundaries change",
      "workspace manifest contract changes",
      "workspace surface changes",
      "runtime command behavior changes",
      "tenant overlay template changes",
      "PyCharm generation changes"
    ]
  },
  "importantWorkflows": [
    "CI",
    "CodeQL",
    "Dependency Graph",
    "Dependabot Updates",
    "Devkit live Odoo checks"
  ],
  "prWorkflow": {
    "mergeMethod": "merge",
    "requiredStatusChecks": [
      "test"
    ],
    "additionalCiChecks": [
      "runtime-python-lock"
    ],
    "codeScanningMergeProtection": {
      "ruleset": "Require code scanning results",
      "tool": "CodeQL",
      "alertsThreshold": "errors",
      "securityAlertsThreshold": "high_or_higher"
    },
    "codeQualityMergeProtection": {
      "severity": "errors"
    },
    "requiresStrictStatusChecks": true
  },
  "relatedRepos": [
    "disable_odoo_online",
    "odoo-docker",
    "odoo-shared-addons",
    "odoo-tenant-cm",
    "odoo-tenant-opw",
    "launchplane"
  ],
  "githubSignals": {
    "postMerge": {
      "waitForActions": true,
      "checkSecurityAndQuality": true
    },
    "capabilities": {
      "codeScanning": "available",
      "secretScanning": "available",
      "dependabotAlerts": "available",
      "securityAdvisories": "available"
    },
    "refreshWhen": [
      "repo visibility changes",
      "GitHub plan changes",
      "security settings change",
      "token permissions change"
    ]
  },
  "cleanup": {
    "deleteMergedLocalBranches": true,
    "removeMergedCleanWorktrees": true
  },
  "metadataFreshness": {
    "updateWhen": [
      "docs routing changes",
      "validation gates change",
      "primary commands change",
      "important workflows change",
      "repo relationship changes",
      "cleanup policy changes",
      "ownership boundaries change",
      "workspace manifest contract changes",
      "runtime command behavior changes",
      "tenant overlay template changes",
      "branch protection or rulesets change"
    ]
  }
}