Pay with LINE Pay (原名稱 LINE Pay Taiwan for WooCommerce) 已正式上架至 WordPress.org,因為名稱和代稱皆修改過,所以如果你之前從 WPBrewer 官網下載安裝過 LINE Pay Taiwan for WooCommerce,請移除並重新安裝外掛,這樣才能在日後收到更新通知喔!
這系列文章主要是紀錄自己的上架過程,雖然說上架流程已經有許多社群朋友紀錄,但是自己走過一遍還是感受不一樣,也可以記錄一下自己遇到的問題。在這邊先感謝以下幾位社群朋友的經驗貢獻:
- WordPress 外掛提交步驟說明 by 桓桓鄉寇
- [SVN] 使用 SVN 提交外掛 Plugin 到 WordPress by 一介資男
- 【第 19 天】上架第一個外掛到 WordPress.org by 艾瑞克的沼澤
- 提供新增外掛頁面翻譯的阿力獅 (alexclassroom)
外掛的上架大致會分為 3 個步驟,這篇文章主要會說明到第 2 個步驟,也就是外掛成功審核通過。
- 提交外掛上架申請
- 外掛審核
- 上傳外掛以及相關檔案至指定的 SVN 路徑
上架前準備
在上架之前,最好先確認一下上架規範,以及常見問題,確認外掛都符合規範再提出上架申請,日前審閱團隊也推出了 Plugin Check Plugin (PCP) 方便開發者在上架之前先檢查一下是否有問題,因為目前等待審閱的外掛數量很多,等待時間相對長,如果你審閱過程遇到問題被退回,整個上架過程就會被拉長,也浪費了審閱團隊的資源,所以建議仔細確認一下是否都符合了上架規範,沒問題了再提交申請。
另外安全性也是審閱團隊很注重的一點,所以在提交掛前,請注意外掛程式是否有符合基本的安全性規範,例如資料在輸出前是否有先跳脫 (Escape),或是在收到使用者輸入的資料時是否有先進行過濾 (Sanitize) 和驗證 (Validation),前者可以使用常見的 esc_html 函式,後者則可以使用常見的 sanitize_text_field 函式,更多關於安全性的內容請參考 WordPress 開發者資源網站上關於安全性的說明,若你覺得手動檢查過於繁瑣,建議導入 WordPress Coding Standard 在你的開發流程中,可以幫你快速找出程式中潛在的安全性問題。
而在外掛審閱團隊的官方部落格上也有文件說明了審閱團隊如何進行審閱,這個文件比較偏向於審閱團隊的內部文件以及標準作業流程,你可以了解審閱團隊如何進行審閱,以及檢查的項目,算是蠻有參考價值的內容。
提交外掛上架申請
在確認好外掛都符合規範後,你需要將你的外掛打包成 Zip 檔,然後透過 新增外掛 (Add your plugin) 頁面上傳你的外掛。因為 LINE Pay Taiwan for WooCoomerce 之前已經在官網提供給使用者下載了,所以在上架的時候出現了名稱衝突的警示(這邊因為沒有切換到繁中介面所以截圖內容為英文),如果你的外掛之前沒有在其他地方發佈應該就不會遇到這個問題。
解決的方法也很簡單,如前面畫面裡面提到的,你只要寫信給審閱團隊,告知你要上架的外掛跟名稱衝突的外掛是同一支就可以了,當然你要提供一些證據和說明才行。如果審閱團隊確認無誤,會另外提供一個上傳連結給你,你必須要在指定時間內上傳,不然這個連結就失效了。
上傳完後若回到新增外掛頁面,會顯示你目前正在等待審閱的外掛名稱以及審閱狀態。畫面上還會顯示有幾個外掛正在等待審閱,當時的數量跟目前的數量相比真的是差很多。這邊畫面顯示的是繁體中文,再次感謝翻譯的社群志工阿力獅的貢獻。
外掛審閱
上傳完成後,就會收到一封信,告知你一些注意事項,同時提醒你如果要修改 plugin permalink (slug) 現在還可以改。這邊要注意的是,外掛代稱 (slug) 當外掛審閱通過後就不能變更了,所以如果要改記得在通過審閱之前提出。至於外掛名稱其實是可以日後隨著外掛更新來做修改的,所以也常出現許多外掛在外掛名稱中塞了一堆關鍵字,讓外掛名稱變的很長的狀況出現。
比較常遇到的問題是名稱和代稱的問題,在 WordPress.org 上架外掛,除非你本身就是品牌方,或是你代表品牌方上架,才能使用該品牌當開頭。所以在 4/19 時我收到一封信關於外掛名稱的問題,整封信真的是很長,當下我就決定將外掛改名為 Pay with LINE Pay,同時將代稱改為 wpbr-linepay-tw,避免日後衍生問題。
在收到我的更新之後,又收到了一封信,是關於 readme 內容的問題,主要是 Stable Tag 和外掛版本不符,算是個小問題,修正完透過外部連結(我是用 Google Drive) 提供檔案就可以了。
審閱通過
過了 3 天就收到審閱通過的回覆了(🎉),裡面會提及一些跟 SVN 相關的資訊,但並沒有包含外掛的 SVN 路徑和 WordPress.org 連結。
除此之外會有另一封正式審閱通過的通知,比較奇怪的是信件標題中的外掛名稱還是舊的,讓我有點懷疑我到底能不能繼續用舊的名稱呢?避免日後的困擾,我是沒有繼續用。在這封正式的審閱通過信件中,會包含外掛的 SVN 連結,以及外掛在 WordPress.org 上的連結,另外還包含了 SVN 登入的資訊,告訴你該如何登入 SVN。到這邊審閱的流程大致上就算告一個段落了。
結語
以上就是 Pay with LINE Pay 外掛從提交申請到通過審閱的整個過程,很慶幸自己在外掛審閱大塞車之前通過審閱,從 4/14 成功送出上架申請開始,到 4/25 收到審閱通過的信,總共大約花了 12 天,比我預期的短很多。期間修正的問題有兩個,一個是變更外掛名稱和代稱,另一個是 readme 的 Stable Tag 和外掛版本不符,整體的流程大致都很順暢,當我收到信件回覆時,通常我都會在 1~3 天內處理完要修正的事項然後回覆信件,審閱者也大多都會在 1~3 天回信,很感謝協助審閱外掛的志工,讓我能在比預期還短的時間內通過。
看了一下目前(2023/10/10)等待審閱的外掛已經來到 1192,等待時間大約需要 3 個月,如果有上架需求的建議要提早提交了。
而為了因應這樣大量的審閱需求,外掛審閱團隊除了招募了新的成員和導入新的流程及系統外,同時也推出了新的工具 Plugin Check Plugin (PCP) 給開發者使用,讓要提交上架申請的開發者能夠在提出申請之前,先透過這個外掛提早發現一些問題,避免一來一回耽誤時間,也浪費了審閱團隊的資源,建議有上架需求的開發者一定要使用喔!