1. Products
  2. Github Connector
Public Pricelist

Github Connector

Synchronize information from Github repositories

Technical Name:
github_connector
License:
AGPL-3
Author:
Akretion, GRAP, Sylvain LE GAL
Maintainer:
https://odoo-community.org
Website:
Repository:
https://github.com/OCA/interface-github/tree/10.0/github_connector
https://odoo-community.org/web/image/product.template/1024/image_1920?unique=d4bb063
  • Odoo Version

Terms and Conditions 

Load Github Data in your Odoo Instance

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

Configuration

Once installed, you have to:

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

    • github_login = your_github_login
    • github_password = your_github_password
    • source_code_local_path = /workspace/source_code/

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

  2. go to 'Settings' / 'Technical' / 'Parameters' / 'System Parameters' and define the following values:

    1. github.max_try: number of call to the API before an error is raised. The more unstable/slow tyour connection, the higher should be this value
    2. 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
    /github_connector/static/description/github_settings.png

  3. 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.

Usage

Initial upload from Github

To fetch information from Github, you have to:

  1. go to 'Github' / 'Settings' / 'Sync Object'

  2. Select the object type you want to synchronize and its Gthub name

    /github_connector/static/description/sync_organization.png

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

    /github_connector/static/description/github_organization_kanban.png

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

    /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):

  1. 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.

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

    /github_connector/static/description/github_organization_external_services.png

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

    /github_connector/static/description/github_organization_sync_buttons.png

Team / members synchronization

You can synchronize members teams:

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

    /github_connector/static/description/github_team_kanban.png

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

    /github_connector/static/description/github_team_partner_kanban.png

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

    /github_connector/static/description/github_team_repository_kanban.png

Repositories synchronization

You can synchronize the branches of your repositories:

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

    /github_connector/static/description/github_repository_kanban.png

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

    /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:

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

    /github_connector/static/description/wizard_download_analyze.png

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

    /github_connector/static/description/github_repository_branch_list.png

Data creation in Github

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

  1. Teams:

    1. Go to 'Settings' / 'Create Team in Github'.
    2. Set the information and click on Create in Github.
    3. Odoo will try to create the team. If access right and datas are correct, the creation will be done directly in Github
    4. Later on, a synchronization will be performed, to create the according team in the Odoo instance.
    /github_connector/static/description/wizard_create_team.png

  2. Repositories:

    1. Go to 'Settings' / 'Create Team in Github'.
    2. Set the information and click on Create in Github.
    /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.

Try me on Runbot

Reporting

This module provides several reports

Branches by Serie

/github_connector/static/description/reporting_branches_by_serie.png

Sizes by Serie

/github_connector/static/description/reporting_sizes_by_serie.png

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)

Roadmap / Known Issues

  • 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).

``sudo pip install PyGitHub``

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 smash it by providing detailed and welcomed feedback.

Credits

Contributors

Maintainer

Odoo Community Association

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.

To contribute to this module, please visit https://odoo-community.org.

This is a preview of the recently viewed products by the user.
Once the user has seen at least one product this snippet will be visible.

Recently viewed Products