Join the package collection maintainers/zh-tw

From FedoraProject

< Join the package collection maintainers(Difference between revisions)
Jump to: navigation, search
(將軟體包加入源碼管理 (SCM, Source Code Management) 系統中並設定擁有者)
(檢出模組)
Line 174: Line 174:
 
=== 檢出模組 ===
 
=== 檢出模組 ===
  
You ''could'' check out your module now, but before doing that, consider doing "mkdir ~/fedora-scm ; cd ~/fedora-scm" - that way, all your files are inside that.  Also, run ssh-add, so that you won't have to keep typing in your key password.
+
你現在 ''可以'' 檢出 (check out) 你的模組,但在那之前,請先考慮執行 "mkdir ~/fedora-scm ; cd ~/fedora-scm" - 這樣一來,你的所有檔案都會放在那裡。此外,也執行 ssh-add,那樣你就不需要每次都要打密碼。
  
{{Admon/tip | Running <code>ssh-add</code> before doing any SCM operations is a very good idea. It will save you from having to type your key password for every operation. You only have to run ssh-add once per session, it will remember it until you log out or reboot. If "ssh-add" reports "Could not open a connection to your authentication agent.", start a new shell under it using "exec ssh-agent bash".}}
+
{{Admon/tip | 在任何 SCM 操作之前先執行 <code>ssh-add</code> 會是個好習慣。它可以節省你每次操作都要輸入密碼的時間。每次的作業階段中,你只需要執行 ssh-add 一次,它會記住密碼直到你登出並重新開機。如果 "ssh-add" 回報說 "Could not open a connection to your authentication agent.";那麼開啟新的 shell,並在那裡使用 "exec ssh-agent bash"}}
  
Now you are ready to checkout your module from the SCM:
+
現在你已準備好從 SCM 檢出你的模組:
 
<pre>
 
<pre>
 
  fedpkg clone <packagename>
 
  fedpkg clone <packagename>
 
</pre>
 
</pre>
  
Where <code><packagename></code> should be replaced with the name of your package.
+
這裡的 <code><packagename></code> 應該替換成你軟體包的名稱。
  
 
{{Admon/caution | If this step fails, be sure your private ssh key (<code>~/.ssh/id_rsa</code>) mode is set to 0400. You might have to wait for up to an hour after your request for a new git module has been approved to get write access. Make sure your public key is the same as in the Fedora Accounts System (FAS). Key propagation may take an hour or so after uploading into FAS}}
 
{{Admon/caution | If this step fails, be sure your private ssh key (<code>~/.ssh/id_rsa</code>) mode is set to 0400. You might have to wait for up to an hour after your request for a new git module has been approved to get write access. Make sure your public key is the same as in the Fedora Accounts System (FAS). Key propagation may take an hour or so after uploading into FAS}}

Revision as of 06:31, 12 October 2013

翻譯中...

Contents

貢獻角色

Idea.png
貢獻角色
這些只是貢獻角色上的建議而已,你可以做的不只這些。只有你的想像力可以綁住你!

Join OSDeveloper.png
OS 開發者

如何成為 Fedora 軟體包集合的維護者?

哦,你已決定要成為一位 Fedora 專案中的軟體包維護者?那麼本篇指引會帶你走過第一次提交軟體包的流程。

799px-Fedora-submit-package-zh-tw.png

成為一位 Fedora 軟體包集合的維護者

閱讀規約

若你還不知道如何建立 RPM 軟體包,請參考 How_to_create_a_GNU_Hello_RPM_package/zh-tw 教程,或是另一份更深入且有更多細節的 how to create an RPM package/zh-tw

請閱讀 打包規約 軟體包命名規約

你需要對這些規約仔細且澈底的熟悉,因為所有的軟體包都受這些規約規範。如果你有任何問題,請在 Fedora Packaging 郵遞清單上詢問。

建立 Bugzilla 帳號

請先確認你有 Red Hat Bugzilla 的帳號。

你在 bugzilla 帳號中使用的電子郵件位址應該要和你在 Fedora Account System 中使用的相同,而且任何與 Fedora 打包相關的事務都應該使用同個帳號。

Important.png
如果你已經有 @fedoraproject.org 電子郵件位址,請不要使用它!
你不應該在 Bugzilla 中使用你的 @fedoraproject.org 電子郵件。如果你用了該帳號,一旦得到他人的支助後便無法取得你的 bugzilla 特別權限。如果你真的很想使用你的 @fedoraproject.org 郵件位址,你大概得向 Fedora Infrastructure Ticket System 提出申請,請管理員手動用設定凌駕與你 Fedora 帳號連結的 bugzilla 電子信箱。

建立 Fedora 帳號

Fedora Account System 中建立帳號 (這「不是」bugzilla 帳號)

  1. 請先造訪帳號系統主頁: https://admin.fedoraproject.org/accounts/
  2. 點按「New account」,並填入對應資料。注意,你給的電子郵件應該要與 bugzilla 上申請的郵件相同。這樣系統才可以將相關權力在兩帳號之間相互連接起來。
  3. 在你建立帳號之後,請確認有簽署 CLA (若您點按右上方的「My Account」連結,應該可以看到 CLA: CLA Done)。CLA 是 Contributors License Agreement,代表你身為一位貢獻者,對於本專案相關授權協議同意之書。
  4. 你也需要上傳一份公開的 RSA SSH 金鑰。你需要使用相對應的私人金鑰以透過 SSH 存取 Fedora 機器。你可以前往 此處 閱讀其他相關資料。

參與重要郵遞清單

你必須訂閱 fedora devel-announce 郵遞清單。這是個低流量的郵遞清單,僅供發布消息之用,重要的開發資訊都會張貼到這裡。

你可以訂閱 fedora devel 郵遞清單,Fedora 的主要開發討論都在這裡。這是高流量的郵遞清單。

你可以考慮訂閱 package-announce 郵遞清單 -- 本郵遞清單提供 Fedora 軟體庫中任何軟體包相關的所有提交通知。這是超高流量的郵遞清單。當你是軟體包的維護者 (或共同維護者) 時,若有提交動作,Fedora 軟體包資料庫便會寄送郵件給你。

另一個你可以考慮 (至少看看過去的封存內容) 的郵遞清單是 packaging。這是 Fedora 打包委員會 的郵遞清單,他們訂立了 Fedora 專案的官方打包規約。

確認你想要打包的軟體是否適當

Note.png
請注意,除了提交新軟體包的方式之外,還可以藉由其他方式獲得打包者群組的支助。請看看 如何取得支助 了解更多相關資訊。

你打算提交的軟體包必須是 Fedora 中尚未打包的任何自由與開源軟體專案。在你建立出軟體包之前,請確認該軟體是否真的不在軟體庫中,又或者其實已經進到等候校閱的階段但尚未發布而已。

瞭解你應負的責任

Fedora 納入的軟體組件都需要勤於維護,至於臭蟲,尤其是安全性議題相關的臭蟲更需要即時修正。身為一位 Fedora 軟體包維護員,你的首要 責任 就是確保上述事情能確實施行。我們鼓勵你找一些 共同維護員 來維護軟體包,並透過開發用郵遞清單適時尋求幫助。

看看其他人提交的軟體包

看看一些其他人提交的軟體包來學習打包,並對流程與要求更熟悉。

達成此事的方式之機就是參與 package-review 郵遞論壇;所有的 Fedora 軟體包校閱評註都會一併寄送到此 (從你的角度來看應該是唯讀) 清單。

安裝客戶端工具 (Koji) 並設置你的憑證

若要為 Fedora Collection (Fedora 軟體集) 或是為 Fedora 建置系統中的 EPEL 建置軟體包,你需要採用 Koji

Package-x-generic-16.pngfedora-packager 軟體包提供一些可幫助你設置好 fedora 上相關打包工作的工具;它會幫你帶入一般打包所需的每樣必備工具。請以 root 身份執行下列指令:

yum install fedora-packager

在安裝後,請以一般使用者身份 (非 root) 執行下列指令以 設置你的憑證與與 koji 客戶端組態

fedora-packager-setup
Idea.png
憑證過期
這個動作所產生的憑證會在 6 個月後過期。接著你就必須再次執行 fedora-packager-setup 來申請另一個憑證。每次你申請新憑證時,舊的憑證就會變無效而無法再使用。

你現在可以使用「koji」來嘗試在 Fedora 建置系統上打造 RPM 軟體包,即使是你沒有的平臺或你沒有的 Fedora 版本,該系統都能打造出對應的軟體包。請注意,你可以 (而且絕對應該) 在軟體包被批准且被支助之前,先測試一下建置成果 (這裡指的是「scratch」建置版,也就是從最基本系統打造出的版本)。

koji build --scratch TARGET path_to_source_RPM

其中的

  • TARGET 是指散布版本關鍵字,例如 f17 (代表 Fedora 17)。你可以執行「koji list-targets」來查看所有可用的目標版本有哪些。若要為下個發行版本 (rawhide) 建置軟體包的話,請 不要 使用「dist-rawhide」 - 請改用「fX」,此處的 X 是代表最新穩定版再下一版,或是分支後的發行版。
  • 請注意,你需要提供前往源碼 RPM (檔名結尾為 .src.rpm) 的 路徑,而路徑 不可以 是 URL。 (如果你只有 spec 檔,請使用 rpmbuild --nodeps -bs SPECFILE 來建立新的源碼 RPM)。

你的 koji 軟體包建置僅可以依賴 TARGET 散布版軟體庫中實際擁有的軟體包。因此,若你的軟體包依賴 Bodhi 尚未發行的新軟體包的話,你就無法使用 koji 為發行的散布版建置軟體包。你可以 用 koji 為 rawhide (下個還未發行的版本) 建置軟體包,即使它依賴其他新的軟體包,只要其他軟體包以下方描述方式為「rawhide」建置即可。如果你需要對尚未有穩定的發行更新的軟體包做建置,你可以提交一張請票,請票上加上 rel-eng : https://fedorahosted.org/rel-eng/newticket ,並申請該軟體包加為 buildroot override (建置根基的凌駕之意)。至於 EPEL 中的軟體包,你必須使用 epel 作為 componet 才能讓請求發送給對的負責人。

你可以透過以下指令更深入瞭解 koji:

koji --help            # 一般的幫助說明
koji --help-commands   # 列出 koji 指令
koji COMMAND --help    # 對於某 COMMAND 指令的幫助說明

Using the Koji build system 有更多 Koji 使用上的相關資訊。

製作軟體包

  • 如果你還不知道怎麼製作 RPM 軟體包,請見 How to create an RPM package
  • 請確認你的軟體包有符合 打包規約 軟體包命名規約
  • 請注意 軟體包校閱規約 (這些規則會在軟體包校閱時使用)。
  • 請確認你的軟體包確實可以成功建置。這個要求非常基本,但似乎很多人忘記。這令人訝異地重要,因為很多人提交的成品竟然都無法成功建置。

上傳你的軟體包

上傳你的 SRPM 和 SPEC 檔案到網際網路上的某個地方,好讓他人可以擷取。存放位置可以是任何 URL 能存取的地方,但更重要的是你的檔案應該要可以直接存取,不要躲在某些服務的後方,讓大家還得等候倒數才能下載,又或者將他們重新導向至廣告頁面,那就太糟糕了。 如果你至少有參與一組專案群組,那麼你可以使用 http://fedorapeople.org 來儲放檔案。如果你的帳號除了設好還有簽署 CLA 之外沒做過其他更動,那麼你可以申請 fedorapeople 空間的存取權,請造訪 支助者 trac 實體,並針對「Initial package hosting request」部件提交一份請票。

申請軟體包校閱

填打這份表格: https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&format=fedora-review

  • 在提交你的請求之前,請先確認這個軟體包是否沒有前人提交過申請。在 軟體包校閱狀態頁 上有個方便的搜尋方塊可以使用。
  • 請確認您在 'Review Summary' (校閱摘要) 欄位中有填入 軟體包名稱 (不含版本與發行編號),以及說明該軟體包的非常 簡扼摘要
  • 在 'Review Description' 欄位中填入您軟體包的 說明描述 (通常這可與你在 %description 區段所輸入的相同)。包括您 SRPMSPEC 檔案的 URL 連結。
  • 在您的請票中解釋說這是你打包的第一個軟體包,而且你還需要一位支助者 (This is my first package and I need a sponsor.)。接著請納入對那位未來可能成為你支助者的人來說有所幫助的任何相關資訊。如果你在其他校閱作業中有所作為,也請不吝加上相關連結。如果你正是軟體的上游維護者,請務必明說出來。
  • 如果想加分,請加上 koji 建置成功作業的連結,這樣大家都會知道你做完所有的功課了。
Warning (medium size).png
請確認你在 'Review Description' 欄位中有提及這是你打包的第一個軟體包,而且你正在尋找支助者的幫助 (例如:This is my first package, and I am seeking a sponsor.)。在 Fedora Package Collection 中,所有新的貢獻者都必須有支助者在旁協助。有些可能現身的支助者會查看 bugzilla 中的 FE-NEEDSPONSOR 臭蟲以查找可校閱的軟體包。你可以將你的軟體包加入這份清單中,你只要編輯你的校閱請求臭蟲回報,在 'Bug xyz blocks' 裡面加上 FE-NEEDSPONSOR (xyz 是你那份校閱請求的臭蟲回報編號) 即可。

校閱程序詳細記載於 軟體包校閱程序 頁面上。

知會上游

Fedora 是偏愛 和上游緊密合作 的專案。請通知你打包的軟體的開發者你正在幫它打包。你可以透過寄送電子郵件來介紹你自己,並且指出校閱請求的連結。這樣一來就為將來的可能溝通鋪好路了。他們通常會特地宣傳他們的軟體現在成為 Fedora 中的一部分了;而且如果現在的發行版本有什麼重大的臭蟲需要修正、有什麼未來版本的規劃... 等重要消息時,他們可能會想要通知你。

自我介紹

當一位軟體包新手維護者加入 Fedora 專案時,我們會要求他/她在 Fedora 的 Devel 郵遞清單上自我介紹。若要註冊這個郵遞清單,請先造訪 devel 清單的註冊頁。此動作的主要用意是讓你可以熟悉其他軟體包維護者,並開始建立對你的信任,可讓你的校閱請求未來處理得更快一些。

此清單的根本用途是要破除匿名性、促進專案社群真實互動,不過你並沒有義務揭開你的個人秘密。主要目標是要讓你與專案的其他成員之間建立出某種程度的信任。

主旨:Self Introduction

正文:可以加入任何你覺得有用處的相關資訊,像是過去的經驗、你提交的校閱請求連結、關於你自己的簡短描述。如果你希望的話,也可以張貼你的 GPG 金鑰資訊。

持續關注別人給你的反饋

關注你第一個軟體包的 Bugzilla 回報。你應該會透過電子郵件收到通知。修正任何檢閱者指出的發行阻擋議題 (blocker,即未經修正則不應發行的阻擋關卡)。

取得他人支助

一旦軟體包由校閱者 APPROVED (批准) 後,你必須另外取得成員支助才能檢入 (check in) 與建置 (build) 你的軟體包。「支助」(Sponsorship) 不是自動的,你可能需要以不同方式進一步參與來展現出你已經很明瞭打包規約了。被支助的關鍵是要說服現有的支助等級成員 (sponsor-level member) 你不僅了解更會遵守本專案的規約與流程。

請見 如何取得支助以進入打包者群組 查看更多支助程序的資訊。

Warning (medium size).png
新打包者的第一個軟體包其校閱與批准 必須 由註冊的支助者處理。後續的校閱則可由任何一位軟體包維護者處理。非正式的校閱則可由任何有興趣的人處理。

你的支助者可以將你加入打包者群組中。你應該會收到你被支助的電子郵件通知。

將軟體包加入源碼管理 (SCM, Source Code Management) 系統中並設定擁有者

若你正打算成為新軟體包的維護者,而不是成為共同維護者,請跟隨 Package SCM 管理員請求 的指示,來取得您新軟體包與分支最近發行版本的模組。

這用來在擁有者資料庫中設置適當的記錄,用來存取建置軟體包、bugzilla 情報狀態、其他功能等。這一步會在倉儲中建立你新軟體包的模組,以及每個請求的散布版本分支。

檢出模組

你現在 可以 檢出 (check out) 你的模組,但在那之前,請先考慮執行 "mkdir ~/fedora-scm ; cd ~/fedora-scm" - 這樣一來,你的所有檔案都會放在那裡。此外,也執行 ssh-add,那樣你就不需要每次都要打密碼。

Idea.png
在任何 SCM 操作之前先執行 ssh-add 會是個好習慣。它可以節省你每次操作都要輸入密碼的時間。每次的作業階段中,你只需要執行 ssh-add 一次,它會記住密碼直到你登出並重新開機。如果 "ssh-add" 回報說 "Could not open a connection to your authentication agent.";那麼開啟新的 shell,並在那裡使用 "exec ssh-agent bash"。

現在你已準備好從 SCM 檢出你的模組:

 fedpkg clone <packagename>

這裡的 <packagename> 應該替換成你軟體包的名稱。

Stop (medium size).png
If this step fails, be sure your private ssh key (~/.ssh/id_rsa) mode is set to 0400. You might have to wait for up to an hour after your request for a new git module has been approved to get write access. Make sure your public key is the same as in the Fedora Accounts System (FAS). Key propagation may take an hour or so after uploading into FAS
Important.png
Note that fedpkg does not set the user config for your new git repo automatically. Make sure to have these set globally or locally in your new repo before you do your first commit (see Configure your global git settings).
Important.png
Note: If you are not a member of the fedora packager group, you will receive a "permission denied" error. Use the -a flag to clone anonymously.

測試你的軟體包

請參考 Using_Mock_to_test_package_builds 以及 Using_the_Koji_build_system#Scratch_Builds 瞭解更多測試軟體包的相關資訊。Mock 使用的是你的本地端系統,而 Koji 命令列工具則使用 Fedora 建置系統伺服器。

匯入、提交、建置你的軟體包

現在你已用 fedpkg 檢出你的 (空白) 軟體包模組, cd 進入模組的主要分支 (master branch):

cd <packagename>

執行 fedpkg 將 SRPM 的內容匯入 SCM 中:

fedpkg import PATH_TO_SRPM
# Review Changes, press 'q' to stop; Revert with: git reset --hard HEAD
git commit -m "Initial import (#XXXXXX)."
git push
fedpkg build

很明顯,請把這裡的 PATH_TO_SRPM 換成你被批准的 SRPM 的完整路徑 (不是 URL),而 XXXXXX 則換成軟體包校閱的臭蟲回報編號。

這只會匯入、提交、建置 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/acls/name/PACKAGE_NAME 以請求相關權利。


更新你的分支 (如果想要的話)

Branches are f# (formerly F-# and before that FC-#), master, etc. So f20 is the branch for Fedora 20.

To switch to a branch first:

fedpkg switch-branch BRANCH (e.g. f20)

Merge the initial commit from master, creating an identical commit in the branch:

git merge master

Push the changes to the server:

git push

Build the package:

fedpkg build

If there is another branch to work with repeat "To switch to a branch" and import and commit to each branch

Warning (medium size).png
Be sure that you build for rawhide (master) branch before pushing updates for any other branches! Otherwise, those updates will get inherited into rawhide, which is almost certainly not what you want.
Warning (medium size).png
Sync to buildsys is an hourly thing. So, sometimes you might have to wait for an hour to get access of the build server to give "fedpkg build"

If everything goes well, it should queue up your branch for building, the package will cleanly build, and you're done!

If it fails to build, the build system will send you an email to report the failure and show you to the logs. Commit any needed changes to git, bump the SPEC release number, and request a new build.

用 Bodhi 提交軟體包更新

Fedora 更新系統稱為 Bodhi (即中文之菩提),用於推送更新、分類軟體包等。 請不要透過 bodhi 提交「master」版的 (即 rawhide 版) 軟體包。

你可以透過下列指令使用 Bodhi 來推送任何 branch 分支中的更新:

 fedpkg update

你也可以直接使用 "bodhi" 指令,指令記載於 Bodhi Instruction 中。

你也可以使用 Bodhi 的網頁介面 來請求你想將新的補強性更新帶到哪個發行的 Fedora 版本中。

第一個欄位會詢問你軟體包 "Package" 的名稱。這個欄位會自動從 Koji 建置系統中自動補完軟體包名稱,例如 <package-name>-<version>-<release>.fc20。如果補完功能沒有作用,請自行輸入軟體包建置名稱。

如果是新的軟體包,請選擇 "newpackage" (新軟體包) 作為更新的 "type" (類型)。

如果你想要先讓軟體包作測試用,請把 "Request" (請求) 設為 "testing" (測試),詳情請見 Fedora 品質保證。如果你想要讓軟體包直接推入穩定版,則請設為 "stable" (穩定)。

對於新的軟體包,請將軟體包 "Bugs" 欄位中的 Review Request 臭蟲編號留空。當它推入所請求的更新狀態時,Bodhi 會自動將它以 NEXTRELEASE 狀態關閉。

對於新的軟體包,請在 "Notes" 區段中加入軟體包的描述說明副本,這樣一來終端使用者才會知道這個軟體包究竟是什麼。

這裡有份 Bodhi 使用指引

當你透過 bodhi 提交一份升級之後,你的軟體包就會擺入佇列中。管理員會定期檢查佇列,並將所有的軟體包推入適當的軟體庫中。

讓軟體包列在「comps」檔案中

如果軟體包適當,讓它列在「comps」檔案中,這樣一來就可以在安裝時選擇該軟體包,而且也可納入 yum 的軟體包群組操作中。請見 How to use and edit comps.xml for package groups 以瞭解更多資訊。

持續查看更新狀況

Fedora 有可用的基礎設施可監控你打包的軟體是否有新的上游發行版本。請參考 上游發行監控 瞭解更多細節資訊。若要學習如何處理更新,請閱讀 軟體包更新指南

取得幫助

我們了解這套流程有時可能讓你如入五里霧中,但我們總試著讓情況變得更好。如果你遇到任何問題,或是有任何疑問,請不要遲疑前往 devel 郵遞清單發問,或是上 freenode.net 的 #fedora-devel[?] 頻道上討論。

Fedora Mentors Project 中有許多願意幫助新手打包的導師。請查看 Mentors 頁面了解更多相關資訊。

也請見 Using_git_FAQ_for_package_maintainers

若你已是維護者且還想要製作新的軟體包推入 Fedora 軟體包集合

若你已有維護 Fedora 的軟體包,並且想要維護新的一個,請遵循 既有貢獻者的新軟體包流程