Dockery-Odoo

Join our growing community!

GitHub stars Docker Pulls By XOE

Beyond simplicity

We made a tool.
It’s called OdooUp.

$ sudo pip install odooup
$ odooup init <PROJECTNAME>

From there, just keep watching.
It will unveil it’s beauty all by itself.

Watch it in action

Usage Scenarios

There are two main usage scenarios.


Client Project


Characteristics:

  • Module dependencies are vendored in vendor/<ORG>/<REPO>/<MODULE>1.
  • src is used for custom development.
  • It is best practice to version control configuration and meta-data.
  • Such custom_config module satisfies the min. module condition.
  • Uses the migration controller for orchestrated module upgrades.

1 Use sparse-checkout to only get the modules you need.

Odoo Dev Team


Characteristics:

  • Stable repos are vendored in vendor/<MYORG>/<REPO>.
  • Module dependencies, if any, same as for Client Projects.
  • src is used for pre-release module development.
  • src is a shared workdir on the team’s remote repo. 1
  • The team uses feature branches to develop new modules.
  • After beta acceptance, the module is published in a vendored repo. 2
  • Further maintenance is done on that target repo.
  • Uses the migration controller for migration script validation.

1 Nice: src modules override their namesakes in vendored repos, as they are placed into .../090, the last (-> first) addon path.

2 Use “Initial commit” to squash development history or git subtree commands to preserve it or, to get fancy, adopt a git subrepo workflow to keep disconnected histories in sync during beta phase.

Remember:

  • Best use a git submodule workflow for your vendored repositories.
  • For sparse-checkout on submodules, start with this stackoverflow answer.

Next Steps:

  • Set up your Deployment Infrastructure.1
  • Customize your CI/CD pipeline.2
  • Join our growing Telegram Community to get help from other early birds.
  • Submit a blog post of your journey to be chosen and linked as reference implementation of either scenario.

1 Odoo-Operator will do canary deployments and operate review apps.
2 We recomend GitLab as the best available development lifecycle companion.

Features

Dockery-Odoo is the fastest and cleanest way to get up to speed with your Odoo development.

Docker Based

Leverage industry best practices through a docker centric development workflow.

Kubernetes Ready

Built with industry standard kubernetes deployment and operation model in mind.

Convenience by Default

Never again waste time on project setup, ever.

Ecosystem Player

Optimized for excellent teamplay with CI/CD.

Descriptive Migration

An improved descriptive migration controller build into it.

Translation (to come)

Integration with Transifex, Weblate, GitHub and GitLab.

Driven by you

For a fun and joyful community experience!
We have all been waiting too long.


Join the conversation!


… also on Telegram.