Github Connector

Para instalar este addon, necesita instalar algunas dependencias de python

sudo pip install PyGitHub
sudo apt install cloc
sudo pip install pathspec
sudo pip install GitPython

El código fuente de Analysis se genera mediante

Una vez instalado, debe:

• Abrir su archivo odoo.conf y añadir ajustes adicionales para indicar las credenciales de Github y la ruta local donde se descargará el código fuente:
• source_code_local_path = /workspace/source_code/

Nota: puede definir la ruta como variable de entorno usando la clave SOURCE_CODE_LOCAL_PATH

Nota: asegúrese de que el proceso de Odoo tiene acceso de lectura / escritura en esa carpeta

> - github_token = your_github_access_token

Nota: La autenticación login/password ha quedado obsoleta en GitHub.

• Vaya a 'Settings' / 'Technical' / 'Parameters' / 'System Parameters' y defina los siguientes valores:
• github.max_try: número de llamadas a la API antes de que se genere un error. Cuanto más inestable/lenta sea su conexión, mayor debería ser este valor
• git.partial_commit_during_analysis: Establezca en True si desea confirmar el resultado del análisis en la base de datos después de cada análisis de repositorio. Recomendamos establecer en True cuando realice la descarga inicial (potencialmente con muchos repositorios) para reducir el tamaño de la transacción
• Vaya al formulario de su(s) usuario(s) para añadirlos a los nuevos grupos 'Connector Github Manager'. Los miembros de este grupo tendrán la posibilidad de ejecutar la sincronización de Github.

Technical Information

Este módulo proporciona 4 crons que puede habilitar:

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

Carga inicial desde Github

Para obtener información de Github, debe:

• ir a 'Github' / 'Settings' / 'Sync Object'
• Seleccionar el tipo de objeto que desea sincronizar y su nombre de Gthub
• Una vez hecho para su(s) organización(es), vaya a 'Github' / 'Github Commnunity' / 'Organizations'
• Opcionalmente, una vez creada la organización, puede crear series para sus proyectos. Vaya a 'Github' / 'Organizations' / haga clic en su organización / pestañas 'Organization Series'

Seleccionar ramas a descargar

Esta configuración evitará descargar ramas no deseadas, descargando solo las ramas principales (releases):

• En la pestaña 'Settings', establezca los repositorios que no desea descargar (o los repositorios que desea descargar). Si se establece 'Specific repositories', el valor de 'Ignored Repositories' se ignora.
• En la pestaña 'Settings', establezca la URL de los 'External Services' que utiliza para Continuous Integration y Coverage.
• Una vez hecho, haga clic en los botones 'Syncs', para sincronizar repositorios, equipos y miembros. (Este proceso puede tardar un tiempo dependiendo de su tamaño)

Sincronización de equipos / miembros

Puede sincronizar los equipos de miembros:

• Vaya a 'Teams' / vista de árbol / 'Actions' / 'Update from Github'.
• En cada equipo, puede ver la lista de miembros y el rol de los miembros
• En cada equipo, puede ver la lista de repositorios pero no los permisos del equipo. (Consulte la sección 'Known Issues')

Sincronización de repositorios

Puede sincronizar las ramas de sus repositorios:

• Vaya a 'Repositories' / vista de árbol / 'Actions' / 'Update from Github'
• En cada repositorio, puede ver la lista de ramas principales y el tamaño del código fuente.

Obtener el código fuente

Finalmente, puede descargar localmente el código fuente de todas sus ramas:

• Vaya a 'Repository Branches' / vista de árbol / 'Actions' / 'Download and Analyse Source Code'.
• En la vista de árbol puede actualizar manualmente el código fuente o refrescar el análisis.

Análisis del código fuente

Es posible crear reglas de análisis personalizadas que se relacionen con una organización de GitHub, un repositorio de GitHub y/o una rama de repositorio de GitHub para analizar el código.

• Vaya a 'Settings' / 'Analysis rule groups' y cree registros que permitan organizar las reglas
• Vaya a 'Settings' / 'Analysis rules' y cree reglas, por ejemplo:

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

Nota: El campo Paths en 'Analysis rule' permite poner múltiples rutas por línea, el formato de ruta es según

• Vaya a GitHub \> GitHub Community \> Organizations y defina reglas de Analysis (opcional)
• Vaya a GitHub \> GitHub Repository \> Repositories y defina reglas de Analysis (opcional)
• Vaya a GitHub \> GitHub Repository \> Repository Branches y defina reglas de Analysis (opcional)

El análisis del código fuente se ejecuta cuando el botón 'Update Source Code Analysis' en algún 'Repository Branch', obtiene todas las reglas de Analysis (Repository + Organization) y analiza el código y genera información sobre él. Otra opción para el análisis del código fuente está en el cron llamado 'Analyze Source Code for All Github Branches'

Puede ver en 'Repository Branch' / 'Code Analysis' la información obtenida de las reglas de análisis.

Creación de datos en Github

Tiene la posibilidad de crear dos elementos en Github directamente desde Odoo

• Equipos:
• Vaya a 'Settings' / 'Create Team in Github'.
• Establezca la información y haga clic en Create in Github.
• Odoo intentará crear el equipo. Si el derecho de acceso y los datos son correctos, la creación se realizará directamente en Github
• Posteriormente, se realizará una sincronización, para crear el equipo correspondiente en la instancia de Odoo.
• Repositorios:
• Vaya a 'Settings' / 'Create Team in Github'.
• Establezca la información y haga clic en Create in Github.

Nota

El análisis en este módulo es básico: por el momento, solo proporciona el tamaño de las ramas.

No obstante, puede desarrollar un módulo Odoo Custom extra para extender la función de análisis y obtener estadísticas extra, dependiendo de sus necesidades.

De esa forma, puede ver el módulo github_connector_odoo, si sus repositorios contienen módulos de Odoo.

Informes

Este módulo proporciona varios informes

Branches by Serie

Sizes by Serie

Repository branch analysis rule