Gogs开源软件for Huawei任务规划
1 需求分析
1.1 开源软件基本情况
1. Gogs是一款轻量级、跨平台、极易搭建的自助 Git 服务。旨在打造一个以最简便的方式搭建简单、稳定和可扩展的自助 Git 服务。使用 Go 语言开发使得 Gogs 能够通过独立的二进制分发，并且支持 Go 语言支持的所有平台，包括 Linux、macOS、Windows 和基于 ARM 的操作系统。
主要功能：
• 控制面板、用户页面以及活动时间线
• 通过 SSH、HTTP 和 HTTPS 协议操作仓库
• 管理用户、组织和仓库
• 仓库和组织级 Webhook，包括 Slack、Discord 和钉钉
• 仓库 Git 钩子、部署密钥和 Git LFS
• 仓库工单（Issue）、合并请求（Pull Request）、Wiki、保护分支和多人协作
• 从其它代码平台迁移和镜像仓库以及 Wiki
• 在线编辑仓库文件和 Wiki
• Jupyter Notebook 和 PDF 的渲染
• 通过 SMTP、LDAP、反向代理、GitHub.com 和 GitHub 企业版进行用户认证
• 开启两步验证（2FA）登录
• 自定义 HTML 模板、静态文件和许多其它组件
• 多样的数据库后端，包括 PostgreSQL、MySQL、SQLite3 和 TiDB
• 超过 31 种语言的本地化
• 所属社区：Gogs Labs社区。
• License： MIT license。
• 源代码地址：https://github.com/gogs/gogs。
• 官网主页：https://gogs.io/。
• 主要开发语言：Go & Less & Javascript & Shell。
2. 项目数据：Fork 4.9K, Star 45.2K, Contributor 497，最近一次提交：2024-12-01
star历史（https://star-history.com/）：
1.2 任务目的和范围
本任务的主要目的是让Gogs社区支持华为云Euler，包括ECS、CCE，帮助拓展华为云的影响力，方便用户使用Gogs的时候，能够使用GaussDB作为数据源，并且能够部署在华为云Euler上。
能力要求
完成该任务需要具备相关Go和Javascript (最好有Less) 开发经验，熟悉Gogs的设计架构与使用，最好能够熟悉GaussDB、及华为云相关生态。能够部署搭建Gogs，演示DEMO会涉及JavaScirpt前端（可选）。
适配任务清单
|
生态 |
生态细类 |
是否需要验证 |
验证逻辑说明 |
是否需要适配 |
适配场景说明 |
|
昇腾生态 |
指令 |
否 |
使用昇腾处理器运行应用。 |
否 |
使用昇腾指令实现适配逻辑。 |
|
CANN |
否 |
应用功能依赖于CANN运行。 |
否 |
使用CANN实现适配逻辑。 |
|
|
MindSpore |
否 |
应用功能依赖于MindSpore运行。 |
否 |
使用MindSpore实现适配逻辑。 |
|
|
鲲鹏生态 |
指令 |
是 |
使用鲲鹏处理器运行应用。 |
否 |
使用鲲鹏指令实现适配逻辑。 |
|
Euler |
是 |
使用Euler系统运行应用。 |
否 |
使用Euler系统调用实现适配逻辑。 |
|
|
数据库生态 |
GaussDB |
是 |
使用GaussDB功能。 |
否 |
使用GaussDB的驱动和SQL实现适配逻辑。 |
|
|
GaussDB(DWS) |
否 |
使用GaussDB（DWS）功能。 |
否 |
使用GaussDB(DWS)的驱动和SQL实现适配逻辑。 |
|
存储生态 |
OBS |
否 |
使用OBS功能。 |
否 |
基于OBS API访问实现适配逻辑。 |
|
鸿蒙生态 |
HarmonyOS |
否 |
使用HarmonyOS系统运行应用。 |
否 |
使用HarmonyOS系统调用实现适配逻辑。 |
2 工作量评估
|
任务 |
人/天 |
|
完成GaussDB数据库开发 |
3 |
|
基于CCE容器完成环境搭建和DEMO验证 |
1 |
|
输出开发资料和博客 |
1 |
|
代码推送上游社区和发布版本 |
1 |
|
总计 |
6人天 |
3 任务分解
3.1 完成GaussDB数据源适配开发
3.1.1在Github完成项目Fork，并完成GaussDB数据库适配需要的脚本和代码开发。
数据源插件开发：使用GaussDB作为数据源需要在项目中新增数据库连接驱动，有2种 解决方案：本任务使用GaussDB商业驱动openGauss-connector-go-pq替换PostgreSQL原生 驱动，和开源软件针对PostgreSQL提供的扩展模块。（即只替换驱动不修改代码） 。
3.1.2 在配置信息中新增GaussDB数据源，然后在 Gogs 的开发模式下启动Gogs。访问 Gogs Web，确认插件是否在 首次运行安装程序 > 数据库类型 中可见。
3.1.3 编写单元测试，确保服务功能正常，为服务撰写使用说明，包含安装步骤、配置选项及示例，如果将服务分享给社区，遵循 Gogs 的发布指南，打包并发布插件(可选）。
GuassDB SDK参考: https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforopenGauss/sdk?api=DeleteInstance
Gogs编写新的数据源插件：https://bbs.huaweicloud.com/blogs/439075
开源软件连接GaussDB驱动：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/issues/24
3.2 完成GaussDB、Euler演示DEMO设计
参考下面的web页面，数据库类型可以选择GaussDB：
3.3 DEMO开发、部署和验证
根据DEMO设计，完成演示功能开发和部署。要求使用CCE容器（Euler镜像）进行部署。
DEMO验证:
部署Gogs，访问 Gogs Web 修改配置信息选择数据库类型为 GaussDB ，在面板中创建用户，并使用创建的用户登录。对比GaussDB验证数据准确性。查看Gogs日志文件，确保没有报错或警告。
3.4 在华为云开发者论坛输出博客
在华为云开发者论坛发表博客，介绍完成这些任务的过程和心得。包括如下内容：Gogs、GaussDB及华为云功能介绍；安装部署指导；验证DEMO功能等。
3.5 代码推送上游社区
将代码合并到Gogs官网主干代码；更新Gogs官网资料，包括版本说明、开发指南等。
4 任务评分和验收材料
1.验收评分（总分100分）
|
验收细则 |
评分说明 |
是否为验收必选项 |
结果（通过/不通过） |
开发者举证 |
|
功能开发：完成与华为三大根技术生态（鲲鹏云、昇腾云、鸿蒙）适配的功能开发 |
完成GaussDB数据库适配功能开发。 |
是 |
|
|
|
代码质量：适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
是 |
|
|
|
提供相关文档，比如部署文档、使用文档、配置文档等 |
根据社区要求，完善相关的开发指南和部署指导 |
否 |
|
|
|
合入到开源项目主仓：代码推送上游社区 |
代码合并到当前主干分支。 |
是 |
|
|
|
Deomo设计&开发：完成功能演示Demo的开发 |
提供DEMO仓库地址。 |
是 |
|
|
|
Demo部署&验证：完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的截图举证。 |
是 |
|
|
|
发布博客：发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
|
|
|
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
|
|
|
单机版镜像上架时支持模板部署。 |
|
否 |
|
|
|
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
|
|
|
集群版镜像上架时支持模板部署 |
|
否 |
|
|
5 参考资料
1. 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
- 点赞
- 收藏
- 关注作者
评论（0）