apps-store/github_connector/README.rst

================
Github Connector
================

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/licence-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%2Finterface--github-lightgray.png?logo=github
    :target: https://github.com/OCA/interface-github/tree/13.0/github_connector
    :alt: OCA/interface-github
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/interface-github-13-0/interface-github-13-0-github_connector
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
    :target: https://runbot.odoo-community.org/runbot/229/13.0
    :alt: Try me on Runbot

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

This module allows you to:

* Fetch into Odoo social information from Github (Organizations, Teams, Users)
* Fetch into Odoo Code structure information from Github (Repositories,
  Branches)
* Download source code from Github
* Analyze repository code from rules previously created

**Table of contents**

.. contents::
   :local:

Installation
============

To install this addon, you need to install some python dependencies

.. code-block:: bash

   ``sudo pip install PyGitHub``
   ``sudo pip install pygount``
   ``sudo pip install pathspec``

Analysis source code is generated by https://github.com/roskakori/pygount

Configuration
=============

Once installed, you have to:

#. Open your odoo.conf file and add extra settings to mention Github
   credentials, and the local path where the source code will be downloaded:

   * ``source_code_local_path = /workspace/source_code/``

Note: you can define the route as environment variable using the key
SOURCE_CODE_LOCAL_PATH

Note: make sure that Odoo process has read / write access on that folder

   * ``github_token = your_github_access_token``

or

   * ``github_login = your_github_login``
   * ``github_password = your_github_password``

Note: if token and login/password are provided, the token will be used.
The login/password auth will be deprecated by GitHub in the future.

#. Go to 'Settings' / 'Technical' / 'Parameters' / 'System Parameters'
   and define the following values:

   #. ``github.max_try``: number of call to the API before an error
      is raised. The more unstable/slow your connection, the higher should be
      this value
   #. ``git.partial_commit_during_analysis``: Set to ``True`` if you want to
      commit the result of the analysis in the database after each repository
      analysis. We recommend to set to ``True`` when you perform the initial
      download (potentially with a lot of repositories) in order to reduce the
      size of the transaction

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_settings.png

#. Go to your(s) user(s) form to add them in the new 'Connector Github Manager'
   groups. The members of this group will have the possibility to run Github
   synchronization.

Technical Information
~~~~~~~~~~~~~~~~~~~~~

This module provides 4 crons that you can enable:

* Synchronize All Organizations and Teams (``cron_update_organization``)
* Synchronize Branches List for All repositories (``cron_update_branch_list``)
* Download Source Code for All Github Branches (``cron_download_code``)
* Analyze Source Code for All Github Branches (``cron_analyze_code``)

Usage
=====

Initial upload from Github
~~~~~~~~~~~~~~~~~~~~~~~~~~

To fetch information from Github, you have to:

#. go to 'Github' / 'Settings' / 'Sync Object'
#. Select the object type you want to synchronize and its Gthub name

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/sync_organization.png

#. Once done for your organization(s), go to 'Github' / 'Github Commnunity' /
   'Organizations'

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_organization_kanban.png

#. Optionally, once organization is created, you can create series for your
   projects. Go to 'Github' / 'Organizations' / click on your organization /
   'Organization Series' Tabs

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_organization_series.png

Select branches to download
~~~~~~~~~~~~~~~~~~~~~~~~~~~

This setting will prevent to download undesired branches, downloading only
main branches (releases):

#. In the 'Settings' tab, set repositories you don't want to download
   (or repositories you want to download). If 'Specific repositories' is set,
   'Ignored Repositories' value is ignored.

#. In the 'Settings' tab, set the URL of the 'External Services' you use
   for Continuous Integration and Coverage.

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_organization_external_services.png

#. Once done, click on buttons 'Syncs', to synchronize repositories, teams and
   members. (This process can take a while depending of your size)

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_organization_sync_buttons.png

Team / members synchronization
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can synchronize members teams:

#. Go to 'Teams' / tree view / 'Actions' / 'Update from Github'.

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_team_kanban.png

#. In each team, you can see the members list and the role of the members

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_team_partner_kanban.png

#. In each team, you can see the repositories list but not the permissions of the
   team. (See 'Known Issues' Section)

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_team_repository_kanban.png

Repositories synchronization
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can synchronize the branches of your repositories:

#. Go to 'Repositories' /
   tree view / 'Actions' / 'Update from Github'

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_repository_kanban.png

#. In each repository, you can see the main branches list and the size of code
   source.

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_repository_branch_kanban.png

Fetching the source code
~~~~~~~~~~~~~~~~~~~~~~~~

Finally, you can download locally the source code of all your branches:

#. Go to 'Repository Branches' / tree view / 'Actions' / 'Download and Analyse Source Code'.

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/wizard_download_analyze.png

#. In the tree view you can update manually source code or refresh analysis.

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_repository_branch_list.png

Analysis source code
~~~~~~~~~~~~~~~~~~~~~~~~

It's possible to create custom analysis rules that relate to a GitHub organization, GitHub repository and/or GitHub repository branch to analyze code.

#. Go to 'Settings' / 'Analysis rule groups' and create records that allow to organize the rules

#. Go to 'Settings' / 'Analysis rules' and create rules, for example:

  1. Name: All code, Group: General, Paths: ``*``
  2. Name: Python code, Group: General, Paths: ``*.py``
  3. Name: Xml code, Group: General, Paths: ``*.xml``
  4. Name: Repository 1, Group: Custom, Paths: /path/

Note: Paths field in 'Analysis rule' allow to put multiple paths for line, path format is according to https://git-scm.com/docs/gitignore#_pattern_format

#. Go to *GitHub > GitHub Community > Organizations* and define Analysis rules (optional)
#. Go to *GitHub > GitHub Repository > Repositories* and define Analysis rules (optional)
#. Go to *GitHub > GitHub Repository > Repository Branches* and define Analysis rules (optional)

Analysis source code is executed when 'Update Source Code Analysis' button in some 'Repository Branch', get all the Analysis rules (Repository + Organization) and analyze code and generate info about it
Other option to Analysis source code is in cron called 'Analyze Source Code for All Github Branches'

You can see in 'Repository Branch' / 'Code Analysis' the info obtained from analysis rules.

Data creation in Github
~~~~~~~~~~~~~~~~~~~~~~~

You have the possibility to creates two items in Github directly from Odoo

#. Teams:

   #. Go to 'Settings' / 'Create Team in Github'.
   #. Set the information and click on Create in Github.
   #. Odoo will try to create the team. If access right and datas are correct,
      the creation will be done directly in Github
   #. Later on, a synchronization will be performed, to create the according
      team in the Odoo instance.

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/wizard_create_team.png

#. Repositories:

   #. Go to 'Settings' / 'Create Team in Github'.
   #. Set the information and click on Create in Github.

   .. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/wizard_create_repository.png

Note
~~~~

Analysis in this module is basic: for the time being, it just gives branches
size.

Nevertheless, you can develop an extra Odoo Custom module to extend analysis
function and get extra statistics, depending on your needs.

In that way, you can see the module github_connector_odoo, if your repositories
contain Odoo modules.


Reporting
~~~~~~~~~

This module provides several reports

**Branches by Serie**

.. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/reporting_branches_by_serie.png

**Sizes by Serie**

.. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/reporting_sizes_by_serie.png

**Repository branch analysis rule**

.. image:: https://raw.githubusercontent.com/OCA/interface-github/13.0/github_connector/static/description/github_repository_branch_rule_info_report.png

Known issues / Roadmap
======================

* For the time being, Github API doesn't provide some informations that are
  available by the classic UI, that includes:

  1. team hierarchy: the field is present in the model github_team.parent_id,
     but unused.

* Possible improvements:

  1. Create a new module github_connector_website, that could display
     teams / repositories / branches informations for non logged users.

  2. Analyze commits (author, quantity by series, etc...):
     this feature has been partially implemented in a V8.0 PR.

  3. Synchronize Pull Request, Issues, Comments:
     this feature has been partially implemented in a V8.0 PR.

* Refactor the github connector:

  A python library called PyGitHub is available. It could be interesting
  to use it, instead of using custom code. However, this lib doesn't provide
  good access to child object, generating for the time being, unnecessary
  API calls. For example, updating a repository should call before a call to
  the parent organization (The current module is so faster).

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/interface-github/issues>`_.
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
`feedback <https://github.com/OCA/interface-github/issues/new?body=module:%20github_connector%0Aversion:%2013.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
~~~~~~~

* GRAP
* Akretion
* Tecnativa

Contributors
~~~~~~~~~~~~

* Sylvain LE GAL (https://twitter.com/legalsylvain)
* Sébastien BEAU (sebastien.beau@akretion.com)
* Benoît GUILLOT (benoit.guillot@akretion.com)
* Enrique Martín (enriquemartin@digital5.es)
* `Tecnativa <https://www.tecnativa.com>`_:",

  * Pedro M. Baeza
  * Vicent Cubells
  * Alexandre Díaz
  * Ernesto Tejeda
  * Carlos Roca
  * Víctor Martínez

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/interface-github <https://github.com/OCA/interface-github/tree/13.0/github_connector>`_ project on GitHub.

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