|
| 1 | +======================= |
| 2 | +Github Connector - Odoo |
| 3 | +======================= |
| 4 | + |
| 5 | +.. |
| 6 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 7 | + !! This file is generated by oca-gen-addon-readme !! |
| 8 | + !! changes will be overwritten. !! |
| 9 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 10 | + !! source digest: sha256:cc1a7ff52de1c7c111c6f139810de7d928ec8e6c580e2707d1b58961f7bb7266 |
| 11 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 12 | +
|
| 13 | +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png |
| 14 | + :target: https://odoo-community.org/page/development-status |
| 15 | + :alt: Beta |
| 16 | +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png |
| 17 | + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html |
| 18 | + :alt: License: AGPL-3 |
| 19 | +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Finterface--github-lightgray.png?logo=github |
| 20 | + :target: https://github.com/OCA/interface-github/tree/16.0/github_connector_odoo |
| 21 | + :alt: OCA/interface-github |
| 22 | +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png |
| 23 | + :target: https://translation.odoo-community.org/projects/interface-github-16-0/interface-github-16-0-github_connector_odoo |
| 24 | + :alt: Translate me on Weblate |
| 25 | +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png |
| 26 | + :target: https://runboat.odoo-community.org/builds?repo=OCA/interface-github&target_branch=16.0 |
| 27 | + :alt: Try me on Runboat |
| 28 | + |
| 29 | +|badge1| |badge2| |badge3| |badge4| |badge5| |
| 30 | + |
| 31 | +This module was written to extend the functionality of 'Github Connector' |
| 32 | +Module if your repositories contain Odoo Modules. |
| 33 | + |
| 34 | +It extends 'Analysis' features to parse code files (readme / manifest files) |
| 35 | +and add new models and menus. |
| 36 | + |
| 37 | +.. image:: https://raw.githubusercontent.com/github_connector_odoo/static/description/menu.png |
| 38 | + |
| 39 | +**Table of contents** |
| 40 | + |
| 41 | +.. contents:: |
| 42 | + :local: |
| 43 | + |
| 44 | +Configuration |
| 45 | +============= |
| 46 | + |
| 47 | +* Once installed, go to your organization, and set extra settings: |
| 48 | + |
| 49 | +1. The name of your organization in the author keys of the manifest odoo |
| 50 | + modules (in the **Default Author Text** field) |
| 51 | +2. The URL of the file that contains IDs of your repositories for the runbot |
| 52 | + |
| 53 | +.. image:: https://raw.githubusercontent.com/OCA/interface-github/16.0/github_connector_odoo/static/description/github_organization_form.png |
| 54 | + |
| 55 | +If you had analyzed previously your repositories with the |
| 56 | +'github Connector' module, you should launch again the Analysis Process |
| 57 | +for all your Repository Branches. |
| 58 | + |
| 59 | +Usage |
| 60 | +===== |
| 61 | + |
| 62 | +**Odoo Modules** |
| 63 | + |
| 64 | +.. image:: https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_module_kanban.png |
| 65 | + |
| 66 | +In each module, you can see the description of the module, the authors, |
| 67 | +the available series, and the list of the modules that depend on the |
| 68 | +current module. |
| 69 | + |
| 70 | +.. image:: https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_module_form.png |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | +**Odoo Authors** |
| 75 | + |
| 76 | +.. image:: https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_author.png |
| 77 | + |
| 78 | +This list is based on the 'author' key of the manifest file. |
| 79 | + |
| 80 | + |
| 81 | + |
| 82 | +**Odoo License** |
| 83 | + |
| 84 | +This list is based on the 'license' key of the manifest file. |
| 85 | + |
| 86 | +.. image:: https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_license.png |
| 87 | + |
| 88 | + |
| 89 | + |
| 90 | +**Odoo Bin Libs** |
| 91 | + |
| 92 | +This list is based on the 'external_dependencies' / 'bin' key of the |
| 93 | +manifest file. |
| 94 | + |
| 95 | +.. image:: https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_bin_libs.png |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | +**Odoo Python Libs** |
| 100 | + |
| 101 | +This list is based on the 'external_dependencies' / 'python' key of the |
| 102 | +manifest file. |
| 103 | + |
| 104 | +.. image:: https://raw.githubusercontent.com/github_connector_odoo/static/description/odoo_python_libs.png |
| 105 | + |
| 106 | + |
| 107 | + |
| 108 | +**Analysis source code** |
| 109 | + |
| 110 | +Implements Analysis source code in odoo module versions, now add new field called "has_odoo_addons" (boolean) in Analysis rule that allow (if defined) analyze odoo_module_versions and save info about it |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | +**Soource code analysis** |
| 115 | + |
| 116 | +Implements Source code analysis odoo module versions, now addiing new field called "has_odoo_addons" (boolean) in Analysis rule that (if defined) allows to analyze odoo_module_versions and save info about it |
| 117 | + |
| 118 | +In 'Repository Branch' / 'Code Analysis', shows the info related to odoo_module_versions rules analysis too. |
| 119 | + |
| 120 | + |
| 121 | + |
| 122 | +**Reporting** |
| 123 | + |
| 124 | +This module provide a new reporting. |
| 125 | + |
| 126 | +**Modules by Serie (and Licenses)** |
| 127 | + |
| 128 | +.. image:: https://raw.githubusercontent.com/github_connector_odoo/static/description/reporting_module_by_serie.png |
| 129 | + |
| 130 | +Known issues / Roadmap |
| 131 | +====================== |
| 132 | + |
| 133 | +Possible improvements : |
| 134 | + |
| 135 | +* Implement deep code source analysis, like the website http://odoo-code-search.com/ |
| 136 | + and specially: |
| 137 | + |
| 138 | +1. Possibility to search by field or by model name. (Ex: field:invoice_id) |
| 139 | +2. Possibility to display the number of XML, Python, Yaml, HTML, CSS lines |
| 140 | + |
| 141 | +Bug Tracker |
| 142 | +=========== |
| 143 | + |
| 144 | +Bugs are tracked on `GitHub Issues <https://github.com/OCA/interface-github/issues>`_. |
| 145 | +In case of trouble, please check there if your issue has already been reported. |
| 146 | +If you spotted it first, help us to smash it by providing a detailed and welcomed |
| 147 | +`feedback <https://github.com/OCA/interface-github/issues/new?body=module:%20github_connector_odoo%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
| 148 | + |
| 149 | +Do not contact contributors directly about support or help with technical issues. |
| 150 | + |
| 151 | +Credits |
| 152 | +======= |
| 153 | + |
| 154 | +Authors |
| 155 | +~~~~~~~ |
| 156 | + |
| 157 | +* Sylvain LE GAL |
| 158 | +* GRAP |
| 159 | + |
| 160 | +Contributors |
| 161 | +~~~~~~~~~~~~ |
| 162 | + |
| 163 | +* Sylvain LE GAL (https://twitter.com/legalsylvain) |
| 164 | +* `Tecnativa <https://www.tecnativa.com>`_: |
| 165 | + |
| 166 | + * Vicent Cubells |
| 167 | + * Alexandre Díaz |
| 168 | + * Pedro M. Baeza |
| 169 | + * Ernesto Tejeda |
| 170 | + * Víctor Martínez |
| 171 | + * Carolina Fernandez |
| 172 | + |
| 173 | +Maintainers |
| 174 | +~~~~~~~~~~~ |
| 175 | + |
| 176 | +This module is maintained by the OCA. |
| 177 | + |
| 178 | +.. image:: https://odoo-community.org/logo.png |
| 179 | + :alt: Odoo Community Association |
| 180 | + :target: https://odoo-community.org |
| 181 | + |
| 182 | +OCA, or the Odoo Community Association, is a nonprofit organization whose |
| 183 | +mission is to support the collaborative development of Odoo features and |
| 184 | +promote its widespread use. |
| 185 | + |
| 186 | +This module is part of the `OCA/interface-github <https://github.com/OCA/interface-github/tree/16.0/github_connector_odoo>`_ project on GitHub. |
| 187 | + |
| 188 | +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
0 commit comments