贡献角色
如何成为 Fedora 软件包仓库维护人员?
嗯,您已经决定好了要加入了? 本指南会引领您一步一步完成您的第一个软件包维护任务。
成为 Fedora 软件包仓库维护人员
请先完成以下要求
如果您还不知道如何构建一个 RPM 包,请先查阅以下帮助: 如何制作一个 GNU Hello World 软件包 或者更加详细的 如何制作 RPM 包。
您需要十分熟悉以上内容,因为它们包含了许多十分有用的信息。当然,如果您有其它疑问,欢迎到 Packaging 邮件列表提问。
创建您的 Bugzilla 账户
请确保您有一个 Bugzilla 账户。
您的 Bugzilla 帐户注册时填写的邮箱应该与您在 Fedora 账户系统 中的用户所对应的邮箱地址保持一致。
创建一个 Fedora 帐户
首先在 Fedora 账户系统 新建您的个人账户。(注意,此账户与 Bugzilla 账户不同)
- 访问: https://admin.fedoraproject.org/accounts/
- 点击 'New account' 然后填写必填信息。注意,email 需要与 bugzilla 相同。这允许系统在两个帐户之间链接权限。
- 创建帐号后,请签署 CLA (点击顶部的 "My Account" 链接,您可以看到 CLA: CLA Done)。
- 接着,您还需要上传 RSA SSH 公钥。您需要使用匹配的私钥通过 SSH 访问 Fedora 的机器。更多信息请参考 这里。
订阅几个重要的邮件列表
您必须订阅 devel-announce 邮件列表。尽管这只是一个专为发布声明而设的低流量邮件列表,但是许多重要的开发信息都会在这里发布。
您也可以订阅 devel 邮件列表,这是个有关 Fedora 开发的讨论邮件列表,不过请注意流量比较大。
您也可以考虑订阅 package-announce 邮件列表。当软件仓库的软件有变动的时候,邮件列表会有提示。本列表流量十分高,因为每次软件包的改动都会触发系统发送邮件。
当然,查看以前的存档,请订阅 packaging 邮件列表,这是 Fedora 打包委员会 的专用邮件列表。委员们决定有关 Fedora 的软件规定。
确保您的软件包适合 Fedora 项目
您提交的软件包可以是任意种类的开源自由软件,当然最重要的是在我们的源里面尚未被收录。在创建您的软件包之前,请确保该软件包不在软件仓库中且尚未处于被审核状态(意思是这个软件的软件包之前有人已经制作好了,正在提请官方审核)。
因此请一定完成以下 4 步,然后再考虑提交:
- 搜索 Fedora 软件包数据库,以便了解您要提交的软件包是否已经存在。
- 搜索 Review Tracker(审核跟踪器),以便了解哪些软件包正处于被审核状态。
- 检查 已废弃的软件包 列表。
- 留意 禁止提交的软件包。
理解您的责任
Fedora 项目收录的软件包需要被经常维护。尤其是软件有安全更新时,更需要您不断地维护。作为一名 Fedora 项目的软件包维护人员,您需要明确自己的 职责 。我们鼓励您成为一个或多个软件包的 副维护人员 ,当您需要帮助时,请在 Fedora 社区的有关开发的邮件列表中寻找答案。
参阅其他意见
看看其他人提交的软件包,以便学习打包技术并熟悉相关流程。
小提示,您可以订阅 package-review 邮件列表,所有有关软件包审核的修改都会发送至该列表。
配置 Git
您必须先配置好您系统上的 Git,主要是您的个人信息:
git config --global user.name "您的姓名" git config --global user.email "您的电子邮件地址"
请您尽量使用真实信息。
安装开发者客户端工具
欲为 Fedora 和 EPEL 构建软件包,您需要使用 Koji。
fedora-packager
软件包提供相关工具帮助您为 Fedora 打包;它包含所有有关打包的必要工具。以 root 权限安装:
dnf install fedora-packager
安装完成后,请以打包用户的身份(绝对不要使用 root) 来设置证书及 Koji 客户端:
fedora-packager-setup
现在,你可以使用 "koji" 构建系统来尝试编译你的 RPM 包了,它甚至能够为你没有的平台或 Fedora 版本构建软件包。注意,在你的包被批准之前,你绝对应该尝试使用 Koji 进行构建测试。使用以下命令开始一个完整的(scratch)构建测试:
koji build --scratch TARGET SRPM
解释:
- TARGET 表示发行版关键字,例如 f22 (Fedora 22)。你可以运行 "koji list-targets" 来查看所有构建目标。如果要为下一个稳定版(rawhide)进行构建,切记不要使用 "dist-rawhide",要使用 "fX"(X表示最新稳定或 release 分支)。
- 注意,你需要提供源码 RPM 包(以.src.rpm结尾)的路径,而不是URL。(如果只有 spec 文件,需使用
rpmbuild --nodeps -bs SPECFILE
创建新的 SRPM)。
你的 koji 构建项目,只依赖 TARGET 发行版软件源中的软件包。因此,如果你的软件包依赖 Bodhi 中还未发布的新包,则不能使用 koji 进行构建。你可以使用 koji 为 rawhide(下一个预发行版)进行构建,即使它依赖其他新包,只要这些包已为 "rawhide" 构建即可。如果你需要对一个没有稳定发布的软件进行构建,你需要向 https://fedorahosted.org/rel-eng/newticket 发送通知,并要求添加该包为 buildroot。对于 EPEL 打包者,你必须使用 EPEL 组件向正确的人发送请求。
通过以下命令查看 koji 帮助:
koji --help # 通用选项的帮助 koji --help-commands # 列出 koji 子命令 koji COMMAND --help # 查看子命令的帮助
更多关于使用 Koji 的信息,请参考 使用 Koji 构建系统。
制作一个软件包
- 如果您不知道如何构建 RPM 包,请移步这里:如何制作 RPM 包 。
- 确保您的软件包符合 打包规定 和 软件包命名规定 。
- 留意 软件包审核规定 (日后审核时需要)。
- 确保您的软件包可被构建。这的确很重要,因为相当数量的审核请求有这个问题。
上传您制作的软件包
上传您制作的源代码 RPM 包和与之相匹配的 SPEC 配置文件到互联网的任意位置上。请确保其可以通过地址访问,而不要使用网盘或者是赚钱网址来完成。
如果您想要创建一个私有源,请考虑使用 Copr。它是一个轻量级构建系统,可以由您上传的 SRPM 创建源。您可以使用此 Copr 空间为审阅者提供您的 src.rpm 和 spec。
如果您已经加入社区项目组,您可以使用位于 http://fedorapeople.org 的空间来存放。如果您刚刚注册账号,请签署 CLA,并访问 the sponsors trac instance 提交一个 "Initial package hosting request" 支持单,以获得 fedorapeople 的访问权限。
申请审核
您需要首先点击该链接创建一个支持单:https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&format=fedora-review.
- 在您提交审核请求前,确保没有相同的包被请求。软件包审核进度跟踪器 有很方便的搜索功能。
- 确保 软件包 (除去版本号和 release) 在 '
Review Summary
' 栏目中已包含一个关于该包的简要介绍。 - 在 '
Review Description
' 栏中添加该包的 description(通常与 %description 一致)。包括 SRPM 和 SPEC 的 URLs。 - 在审核请求中注明这是您的第一个软件包,同时您需要担保人。包含越多的信息越好。如果您参与过其它软件包的审核工作,请附上相应链接。如果您是上游开发者,也请注明。
- 链接一个成功的 koji 构建是为您的审核通过加分的好方法。
具体我们是如何审核您制作的软件包的,请访问 软件包审核流程 介绍页面。
通知上游开发者
Fedora 项目 与上游项目保持紧密联系。通知上游项目开发者也是您打包工作的一部分。您可以通过向开发者发送一封邮件介绍一下您自己和当前软件包的审核进度来完成。您这么做也为日后反馈提供一个沟通的渠道。这些上游开发者通常很愿意看到自己的软件成为 Fedora 的一部分,他们或许也会通知您已知的 Bug 和未来的开发计划等等。
介绍自己
当一位新人加入 Feodra 软件包维护项目时,我们需要您在 devel 邮件列表介绍一下您自己。请先访问 devel ,然后加入订阅。我们需要您这么做的主要目的是建立大家之间的信任,当然这也有助于大家了解您,以及增加您的软件包被审核成功的几率。
我们这么做还为了打破匿名氛围,并且培养一个项目内的真实世界。您不必透露自己的个人隐私。我们的目标只是建立成员间的友谊。项目成员沟通时,至少要使用真实姓名。
自我介绍信格式:
邮件主题: Self Introduction: 您的姓名
正文: 您想些什么都可以,建议附上您的 GPG 密钥代码。
留意用户反馈
初次加入请注意 Bugzilla 的报告。一旦有用户反馈,您会收到相关邮件。尽可能修复用户提出的 Bug 。
得到担保
当审核者批准了您的审核时(APPROVED),您还必须被担保人担保,以检查/构建你的软件包。担保这项工作的目的是为了确保您对 RPM 的理解认识已经十分透彻。
查看 如何获取被担保资格 以了解更多有关被担保的信息。
您的担保人可以添加您至 packager 组中。通常您会收到确认邮件。
添加软件包至源代码管理系统(SCM)并设置所有者
如果您成为一个新的软件包的主要维护人,而不是是副维护人,请登录 pkgdb [ https://admin.fedoraproject.org/pkgdb/ ] 点击 'request new package' 并填写所需信息(对于 "Ticket number or URL" 字段,粘贴您的 Bugzilla 请求的 URL,然后按 "Sync" 按钮自动填充以下两个字段)。该请求将由管理员审核并处理,通常在 24 小时内完成。
这将用于在所有者数据库中设置正确的记录,用于访问构建包,bugzilla 和其他功能。此步骤将在版本库中为您的软件包创建一个新模块,其中包含每个发布的分支。
签出软件包模块
您现在可以签出模块了。我们建议您新建一个目录专门用来处理这些打包工作,这样所有文件都在一个目录内,方便您的工作。还有,请执行 ssh-add,这样就不用每次输入密码短语来解锁密钥密码了。
从 SCM 签出版本库:
fedpkg clone 您维护的软件包名
测试您制作的软件包
请参考 Using_Mock_to_test_package_builds 和 Using_the_Koji_build_system#Scratch_Builds 以了解更多信息。注意 Mock 使用您的本地环境构建,而 Koji 则使用 Fedora 在线构建系统构建。
导入、提交并构建您的软件包
现在您已经使用 fedpkg 签出您的软件包模块(可能是空的),cd 进入模块主分支:
cd 软件包名
运行 fedpkg 将 SRPM 导入 SCM:
fedpkg import SRPM路径
# Review Changes, press 'q' to stop; Revert with: git reset --hard HEAD git commit -m "Initial import (#XXXXXX)." git push fedpkg build
显然,将SRPM路径
替换为已批准 SRPM 的完整路径,XXXXXX
是审核请求的 Bugzilla 编号。
这将导入所有 commit 内容并仅针对 master (Rawhide) 分支进行构建。
如果提交时,返回以下错误信息:
W access for why DENIED to YOUR_ACCOUNT fatal: The remote end hung up unexpectedly Could not push: Command '['git', 'push']' returned non-zero exit status 128
这就意味着您没有权限修改该分支;请访问 https://admin.fedoraproject.org/pkgdb/package/软件包名 请求权限。
关于 Fedora 包维护系统的更多信息,请查看 Package maintenance guide。
更新软件包分支(如果需要)
分支通常这样命名 f
# (之前为 F-
#)。曾经使用 FC-
#), master
等等。所以 f41 是 Fedora 41 的分支。
首先切换至一个分支:
fedpkg switch-branch BRANCH (例如:f41)
从 master 主分支合并初始 commit,在分支内创建一个相同的 commit:
git merge master
推送修改至服务器:
git push
构建软件包:
fedpkg build
如果有其他分支,重复执行 "切换至一个分支" 并导入/提交每个分支。
如果所有事情都没有问题,那么您的分支就已经加入构建队列,软件包将会被干净的构建,然后就大功告成了!
如果构建失败,构建系统将会发送一封邮件给您,报告失败的缘由,并显示相关日志。您需要提交修改,更新 SPEC 文件的版本号,并重新请求新的构建。
在 Bodhi 中提交软件包更新
Fedora 更新系统名为 Bodhi ,它被用于推送更新,给软件包分类等等。请不要通过 bodhi 提交 Rawhide (master 分支) 软件包。
您可以通过以下命令,使用 Bodhi 为每个分支推送更新:
fedpkg update
您也可以直接使用 "bodhi" 命令来完成,详见 Bodhi 介绍手册。
您还可以使用 Bodhi 页面 为每个 Fedora 版本提交更新。
在您通过 bodhi 提交更新后,您的软件包就已进入队列。一段时间后,管理员会检查队列并推送至相关的源中。
查看 更新提交指南 获得更多信息。
使软件包在 "comps" 中可见
编辑 "comps" 文件,可以将软件包加入 dnf 包组。查看 如何使用和编辑 comps.xml 包组配置文件 获得更多信息。
等待源最后更新
Fedora 有相关可用的基础设施,用于监控上游项目的版本更新。请参阅 Upstream Release Monitoring 以了解更多。阅读 Package update HOWTO 了解我们如何处理软件包更新。
获取帮助
我们也知道这项工作有时候真的很让人头疼,但是我们一直尝试把它做得更好。如果您陷入问题的怪圈中,请到 devel 邮件列表或者位于 freenode.net 的 IRC 频道 #fedora-devel[?] 提问。
Fedora 担保人项目将会有许多人帮助您来参与到打包中。担保人项目页面 有更多信息供您参考。 您也可以查阅 打包者 Git 使用说明。
已经是打包者了?
如果您已经参与维护 Fedora 软件包,并且想要维护其他包,请查阅该 指南。
一次性的贡献
建议通过 pull requests 来修改现有的包,当然你必须有一个 Fedora 帐号才能创建 pull request。
如果你的帐号不在“packager”组里,就不能对 src.fedoraproject.org 上 fork 的仓库提交变更,所以需要借助外部的 Git 平台(例如 https://pagure.io/new) 来发起远程 pull request。