从Github仓库同步信息
项目描述
此模块允许您
从Github获取Odoo社交信息（组织、团队、用户）
从Github获取Odoo代码结构信息（仓库、分支）
从Github下载源代码
根据先前创建的规则分析仓库代码
目录
安装
要安装此插件，您需要安装一些Python依赖项
``sudo pip install PyGitHub``
``sudo pip install pygount``
``sudo pip install pathspec``配置
安装后，您必须
打开您的odoo.conf文件，并添加额外的设置以提及Github凭据，以及源代码将下载到的本地路径
source_code_local_path = /workspace/source_code/
注意：您可以使用键SOURCE_CODE_LOCAL_PATH将路由定义为环境变量
注意：确保Odoo进程有对该文件夹的读写访问权限
github_token = your_github_access_token
或
github_login = your_github_login
github_password = your_github_password
注意：如果提供了token和密码，则使用token。GitHub将在未来弃用登录/密码认证。
转到“设置”/“技术”/“参数”/“系统参数”并定义以下值
github.max_try：在引发错误之前调用API的次数。您的连接越不稳定/越慢，此值应该越高
git.partial_commit_during_analysis：设置为True，如果希望在每次仓库分析后，将分析结果提交到数据库中。我们建议在执行初始下载（可能涉及大量仓库）时将其设置为True，以减少事务大小。
前往您的用户表单，以便在新的“Connector Github Manager”组中添加它们。此组的成员将有机会运行Github同步。
技术信息
此模块提供了4个cron任务，您可以选择启用它们。
同步所有组织和团队（cron_update_organization）
同步所有仓库的分支列表（cron_update_branch_list）
下载所有Github分支的源代码（cron_download_code）
分析所有Github分支的源代码（cron_analyze_code）
使用
从Github的初始上传
要从Github获取信息，您必须
转到“Github”/“设置”/“同步对象”
选择您想要同步的对象类型及其Github名称
为您的组织完成设置后，转到“Github”/“Github社区”/“组织”
可选地，一旦组织创建成功，您可以为项目创建系列。转到“Github”/“组织”/点击您的组织/“组织系列”标签
选择要下载的分支
此设置将防止下载不需要的分支，只下载主分支（发布版）
在“设置”标签中，设置您不想下载的仓库（或您想下载的仓库）。如果设置了“特定仓库”，则忽略“忽略仓库”的值。
在“设置”标签中，设置您用于持续集成和覆盖率的“外部服务”的URL。
完成后，点击“同步”按钮以同步仓库、团队和成员。（此过程可能需要一段时间，具体取决于您的大小）
团队/成员同步
您可以同步成员团队
转到“团队”/树视图/“操作”/“从Github更新”。
在每个团队中，您可以看到成员列表和成员的角色
在每个团队中，您可以看到仓库列表，但不能看到团队权限。（请参阅“已知问题”部分）
仓库同步
您可以同步您的仓库分支
转到“仓库”/树视图/“操作”/“从Github更新”
在每个仓库中，您可以看到主分支列表和源代码的大小。
获取源代码
最后，您可以下载所有分支的源代码
转到“仓库分支”/树视图/“操作”/“下载和分析源代码”。
在树视图中，您可以手动更新源代码或刷新分析。
分析源代码
您可以为与GitHub组织、GitHub仓库和/或GitHub仓库分支相关的分析创建自定义分析规则。
转到“设置”/“分析规则组”并创建记录，以组织规则
转到“设置”/“分析规则”并创建规则，例如
名称：所有代码，组：通用，路径：*
名称：Python代码，组：通用，路径：*.py
名称：Xml代码，组：通用，路径：*.xml
名称：仓库1，组：自定义，路径：/path/
注意：“分析规则”中的路径字段允许放置多个路径，路径格式根据https://git-scm.cn/docs/gitignore#_pattern_format进行格式化。
转到GitHub > GitHub社区 > 组织并定义分析规则（可选）
转到GitHub > GitHub仓库 > 仓库并定义分析规则（可选）
转到GitHub > GitHub仓库 > 仓库分支并定义分析规则（可选）
分析源代码是在某些“仓库分支”中的“更新源代码分析”按钮执行时进行的，获取所有分析规则（仓库+组织）并分析代码并生成相关信息。另一种分析源代码的选项是在cron中名为“分析所有GitHub分支的源代码”。
您可以在“仓库分支”/“代码分析”中查看从分析规则获得的信息。
在Github上创建数据
您可以直接从Odoo在GitHub中创建两个项目。
团队
转到“设置”/“在GitHub中创建团队”。
设置信息，然后在GitHub中点击创建。
Odoo将尝试创建团队。如果访问权限和数据正确，创建将在GitHub中直接完成。
稍后，将执行同步，以在Odoo实例中创建相应的团队。
仓库
转到“设置”/“在GitHub中创建团队”。
设置信息，然后在GitHub中点击创建。
注意
此模块中的分析是基本的：目前，它只提供分支大小。
尽管如此，您可以开发额外的Odoo自定义模块来扩展分析功能并根据您的需求获取额外的统计信息。
这样，您可以查看github_connector_odoo模块，如果您的仓库包含Odoo模块。
报告
本模块提供几个报告
按系列查看分支
按系列查看大小
仓库分支分析规则
已知问题/路线图
目前，GitHub API不提供一些经典UI中可用的信息，包括
团队层次结构：该字段存在于模型github_team.parent_id中，但目前未使用。
可能的改进
创建一个新的模块github_connector_website，该模块可以显示非登录用户团队/仓库/分支信息。
分析提交（作者、按系列的数量等...）：此功能已部分实现在V8.0 PR中。
同步拉取请求、问题、评论：此功能已部分实现在V8.0 PR中。
重构GitHub连接器
有一个名为PyGitHub的Python库可用。使用它可能很有趣，而不是使用自定义代码。然而，此库不提供对子对象的良好访问权限，目前产生了不必要的API调用。例如，更新仓库应该在调用父组织之前调用（当前模块更快）。
错误追踪器
错误在GitHub问题上跟踪。如果遇到问题，请检查是否已报告您的问题。如果您是第一个发现它的人，请通过提供详细和受欢迎的反馈来帮助我们消除它。
请勿直接联系贡献者以获取支持或技术问题的帮助。
致谢
贡献者
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:”，
Pedro M. Baeza
Vicent Cubells
Alexandre Díaz
Ernesto Tejeda
Carlos Roca
Víctor Martínez
维护者
本模块由OCA维护。
OCA，或Odoo社区协会，是一个非营利组织，其使命是支持Odoo功能的协作开发并促进其广泛应用。
本模块是GitHub上OCA/interface-github项目的一部分。
欢迎您贡献力量。要了解如何贡献力量，请访问https://odoo-community.org/page/Contribute。
哈希值 for odoo13_addon_github_connector-13.0.4.0.0-py3-none-any.whl
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 8c1b8af4ed1033e8e470adb5e1833d7f5227a869ff72f724f72938483e80f944 |
|
| MD5 | fd4adf6e9aa14c78cf97e10ca3cf2326 |
|
| BLAKE2b-256 | ef31f8bc0ade217bba2cfeeec3d3f9311f5c227870d7fa3944b4e8e26a910951 |
