odoo-addon-vcp-management 18.0.1.0.0.10

Management for your Version Control Platforms

VCP Management

Creates a set of modules used for handling a version control patform.

Table of contents

• Use Cases / Context

  • Definitions

    • Hosts

    • Platform

    • Repository

    • Requests

    • Rules

• Usage

  • Creation

  • Refresh

  • Management of rules

• Bug Tracker

• Credits

  • Authors

  • Contributors

  • Maintainers

Use Cases / Context

The aim of this module is to allow any community to import data from a version control system.

The system should be done in a way that is agnostic to the system and the connections are handled directly by specific modules.

Definitions

Hosts

Hosts are the origin of data. Each host has a type that helps us know how to integrate with the system. For example, on Github there is only one host (github.com). However, in Gitlab there could be one for each instance that we are integrating too.

Platform

We understand that a platform is an entity that can provide code and information to our Version Control Platform (VCP). A platform could be an organization on Github (like OCA) or Gitlab for example.

Repository

A repository is an origin of code. For example, this repository could be a VCP repository.

Requests

A request is what contributors do to propose new codes. In Github it is a Pull request, however in Gitlab it is called Merge Request.

When a user makes a review on a request, it markes their resolution and some comments. That would correspond to Reviews and Comments.

Rules

Inside a Platform or repository, we can apply some rules to get some basic statistics. This rules are usually done by downloading the code locally and then it can give some basic information like number of lines of code.

Usage

Creation

First step is to create a Platform. In the platform we need to set the host (you might need to create it on gitlab) and add some Platform Keys.

This keys will allow us to integrate with the origin system.

Refresh

By default, the system provides some refresh rules for platforms and repositories, however we can deactivate or activate it manualy.

Management of rules

One of the capabilities of this module is the generation of rules.

This rules allow us to know some information of the repository.

By default, the system adds some rules aligned with odoo to make it easier and allows you to see some examples.

In order to launch this rules, the system must download the code locally.

By default the system is using the following main path (in order, the first one not null is selected):

• Parameter vcp_management.source_code_local_path

• In odoo configuration file, the option source_code_local_path

• System parameter SOURCE_CODE_LOCAL_PATH

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

• Dixmit

Contributors

• Dixmit

  • Enric Tobella

• Akretion

  • Sebastien Beau

Maintainers

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/version-control-platform project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.