yaml文件编写指导
2020-08-11参与贡献流程规范
一、背景介绍
通过yaml文件承载openEuler制品仓软件包的上游社区信息，便于统一校验及管理。
二、yaml文件命名及位置要求
yaml文件名称与仓库名称应该保持一致，并跟软件包的spec文件在同级目录，一般放置到根目录。例如，oemaker代码仓的yaml文件名称是oemaker.yaml，放置到根目录，如下所示：
三、yaml文件字段介绍
yaml文件中需要人工填写的字段有 version_control、src_repo、tag_prefix、separator。
| 字段名 | 字段描述 | 备注 |
|---|---|---|
| version_control | 上游仓库使用的版本控制协议 | 目前支持svn, git, hg, github, gnome, metacpan, pypi, gitee |
| src_repo | 上游仓库的实际地址 | 通过version_control和src_repo我们可以使用工具下载对应的代码 |
| tag_prefix | 上游仓库的tag名version前缀 | 例如，上游给的tag名是v1_0_1, 那么tag_prefix应该配置为"^v" |
| separator | tag中版本的间隔符 | 例如，上游给的tag名是v1_0_1, 那么separator应该配置为"_" |
| version_control类型 | 示例写法（链接） |
|---|---|
| svn | amanda.yaml |
| git | mdadm.yaml |
| hg | nginx.yaml |
| github | asciidoc.yaml |
| gnome | gnome-terminal.yaml |
| metacpan | perl-Authen-SASL.yaml |
| pypi | python-apipkg.yaml |
| gitee | oemaker.yaml |
【版权声明】Copyright © 2024 openEuler Community。本文由openEuler社区首发，欢迎遵照 CC-BY-SA 4.0 协议规定转载。转载时敬请在正文注明并保留原文链接和作者信息。
【免责声明】本文仅代表作者本人观点，与本网站无关。本网站对文中陈述、观点判断保持中立，不对所包含内容的准确性、可靠性或完整性提供任何明示或暗示的保证。本文仅供读者参考，由此产生的所有法律责任均由读者本人承担。
