<h1 class="title">Github Connector - Odoo</h1> <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/interface-github/tree/13.0/github_connector_odoo"><img alt="OCA/interface-github" src="https://img.shields.io/badge/github-OCA%2Finterface--github-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/interface-github-13-0/interface-github-13-0-github_connector_odoo"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/229/13.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p>This module was written to extend the functionality of 'Github Connector' Module if your repositories contain Odoo Modules.</p> <p>It extends 'Analysis' features to parse code files (readme / manifest files) and add new models and menus.</p> <img alt="https://raw.githubusercontent.com/github_connector_odoo/static/description/menu.png" src="https://raw.githubusercontent.com/github_connector_odoo/static/description/menu.png" /> <p><strong>Table of contents</strong></p> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li> <li><a class="reference internal" href="#usage" id="id2">Usage</a></li> <li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</a></li> <li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id5">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id6">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li> <li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li> </ul> </li> </ul> </div> <a name="configuration"></a> <h2><a class="toc-backref" href="#id1">Configuration</a></h2> <ul class="simple"> <li>Once installed, go to your organization, and set extra settings:</li> </ul> <ol class="arabic simple"> <li>The name of your organization in the author keys of the manifest odoo modules</li> <li>The URL of the file that contains IDs of your repositories for the runbot</li> </ol> <img alt="https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector_odoo/static/description/github_organization_form.png" src="https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector_odoo/static/description/github_organization_form.png" /> <p>If you had analyzed previously your repositories with the 'github Connector' module, you should launch again the Analysis Process for all your Repository Branches.</p> <a name="usage"></a> <h2><a class="toc-backref" href="#id2">Usage</a></h2> <p><strong>Odoo Modules</strong></p> <img alt="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_module_kanban.png" src="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_module_kanban.png" /> <p>In each module, you can see the description of the module, the authors, the available series, and the list of the modules that depend on the current module.</p> <img alt="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_module_form.png" src="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_module_form.png" /> <p><strong>Odoo Authors</strong></p> <img alt="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_author.png" src="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_author.png" /> <p>This list is based on the 'author' key of the manifest file.</p> <p><strong>Odoo License</strong></p> <p>This list is based on the 'license' key of the manifest file.</p> <img alt="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_license.png" src="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_license.png" /> <p><strong>Odoo Bin Libs</strong></p> <p>This list is based on the 'external_dependencies' / 'bin' key of the manifest file.</p> <img alt="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_bin_libs.png" src="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_bin_libs.png" /> <p><strong>Odoo Python Libs</strong></p> <p>This list is based on the 'external_dependencies' / 'python' key of the manifest file.</p> <img alt="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_python_libs.png" src="https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_python_libs.png" /> <p><strong>Reporting</strong></p> <p>This module provide a new reporting.</p> <p><strong>Modules by Serie (and Licenses)</strong></p> <img alt="https://raw.githubusercontent.com/github_connector_odoo/static/description/reporting_module_by_serie.png" src="https://raw.githubusercontent.com/github_connector_odoo/static/description/reporting_module_by_serie.png" /> <a name="known-issues-roadmap"></a> <h2><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h2> <p>Possible improvements :</p> <ul class="simple"> <li>Implement deep code source analysis, like the website <a class="reference external" href="http://odoo-code-search.com/">http://odoo-code-search.com/</a> and specially:</li> </ul> <ol class="arabic simple"> <li>Possibility to search by field or by model name. (Ex: field:invoice_id)</li> <li>Possibility to display the number of XML, Python, Yaml, HTML, CSS lines</li> </ol> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id4">Bug Tracker</a></h2> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/interface-github/issues">GitHub Issues</a>. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed <a class="reference external" href="https://github.com/OCA/interface-github/issues/new?body=module:%20github_connector_odoo%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <p>Do not contact contributors directly about support or help with technical issues.</p> <a name="credits"></a> <h2><a class="toc-backref" href="#id5">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id6">Authors</a></h3> <ul class="simple"> <li>Sylvain LE GAL</li> <li>GRAP</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id7">Contributors</a></h3> <ul class="simple"> <li>Sylvain LE GAL (<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>)</li> <li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul> <li>Vicent Cubells</li> <li>Alexandre Díaz</li> <li>Pedro M. Baeza</li> </ul> </li> </ul> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id8">Maintainers</a></h3> <p>This module is maintained by the OCA.</p> <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> <p>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.</p> <p>This module is part of the <a class="reference external" href="https://github.com/OCA/interface-github/tree/13.0/github_connector_odoo">OCA/interface-github</a> project on GitHub.</p> <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>