Metadata-Version: 2.1
Name: odoo-addon-vcp_management
Version: 18.0.1.0.0.11
Requires-Python: >=3.10
Requires-Dist: odoo==18.0.*
Requires-Dist: pathspec
Summary: Management for your Version Control Platforms
Home-page: https://github.com/OCA/version-control-platform
License: AGPL-3
Author: Dixmit,Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

==============
VCP Management
==============

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:49d0c92337984596c4c5c8ca9dcc56988c952e541b00ac0aa8de8984f320ceb5
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fversion--control--platform-lightgray.png?logo=github
    :target: https://github.com/OCA/version-control-platform/tree/18.0/vcp_management
    :alt: OCA/version-control-platform
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/version-control-platform-18-0/version-control-platform-18-0-vcp_management
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/version-control-platform&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

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

**Table of contents**

.. contents::
   :local:

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 <https://github.com/OCA/version-control-platform>`__ 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 <https://github.com/OCA/version-control-platform/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 <https://github.com/OCA/version-control-platform/issues/new?body=module:%20vcp_management%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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

Credits
=======

Authors
-------

* Dixmit

Contributors
------------

- `Dixmit <https://dixmit.com>`__

  - Enric Tobella

- `Akretion <https://akretion.com>`__

  - Sebastien Beau

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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 <https://github.com/OCA/version-control-platform/tree/18.0/vcp_management>`_ project on GitHub.

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