Giter Club home page Giter Club logo

oca-addons-repo-template's Introduction

OCA Addons Repo Template

This is a template created to make easier the task of maintaining OCA addon repositories.

Why?

We have dozens of repos. Most of them look the same, and most of them need specific-but-similar configurations for CI, code quality, dependency management, etc.

We need a place where to evolve those things and push them automatically everywhere else.

This is that place.

How to use?

This is a template. It is based on Copier, go there to read its docs to know how it works.

Quick answer to bootstrap a new repo:

# Install copier and pre-commit if missing
pipx install copier
pipx install pre-commit
pipx ensurepath
# Clone this template and answer its questions
copier copy https://github.com/OCA/oca-addons-repo-template.git some-repo
# Commit that
cd some-repo
git add .
pre-commit install
pre-commit run -a
git commit -am 'Hello world ๐Ÿ––'

Quick answer to update a repo:

# Update the repo
cd some-repo
copier update
# Reformat updated files
pre-commit run
# Commit update
git commit -am 'Updated from template'
# Reformat all other files, in case some pre-commit configuration was updated
pre-commit run -a || git commit -am 'Reformatted after template update'

How to contribute?

Go read our contribution guideline.

Supported use cases

This template allows to bootstrap and update addon repositories for these Odoo versions:

  • 10.0
  • 11.0
  • 12.0
  • 13.0
  • 14.0
  • 15.0
  • 16.0

Future versions will be added as they are released. Past versions could be added as long as they don't break existing branches.

Right now this template is tightly coupled with code, guidelines and decisions from OCA. You might find some things that you can reuse in your own templates, but in general terms this template is not meant to support being used as is for other organizations.

The legal stuff

Copyright holder: Odoo Community Association.

Template license: MIT

License of the rendered repositories: AGPL

License of each module in those rendered repositories: Depends on the module.

oca-addons-repo-template's People

Contributors

sbidoul avatar yajo avatar carmenbianca avatar joao-p-marques avatar pedrobaeza avatar etobella avatar tardo avatar hbrunn avatar theangryangel avatar lmignon avatar simahawk avatar ivantodorovich avatar sirtakobi avatar nilshamerlinck avatar rousseldenis avatar chienandalu avatar yostashiro avatar yvaucher avatar tmotyl avatar legalsylvain avatar stefanrijnhart avatar splashs avatar nosinga avatar mt-software-de avatar celm1990 avatar ap-wtioit avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.