將 Subversion 與 WordPress 插件目錄一起使用

已發表: 2012-07-24

按照這些分步說明在公共 WordPress 插件目錄中添加和更新插件。

視頻中的這些基本步驟如下:

  • 開始使用您的插件
  • 註冊 WordPress.org 帳戶
  • 請求將您的新插件放入 WordPress 插件目錄
  • 為您的機器安裝 SVN 客戶端
  • 為您的項目選擇本地目錄
  • 您的插件請求批准電子郵件
  • 本文的目錄條款
  • 將新的服務器目錄拉到您的本地計算機
  • 完成插件的開發
  • 向公眾提供您的第一個版本
    • 更新項目目錄主幹
    • 在服務器上標記新版本
    • 使用新的標記版本更新本地項目目錄
    • 更新 readme.txt 穩定標籤
  • 插件的新發展

開始使用您的插件

無論您只是有一個想法還是即將完成 0.1 版,您都需要插件的名稱和描述。 使名稱簡短且具有描述性,讓您了解插件的作用。 “Wax on Wax off Plugin”不是一個好名字。 “Drop Shadow Maker”要好得多。 您無需在實際標題中添加“插件”。

為了配合你的標題,你應該寫一個簡短的描述告訴人們你的插件提供了什麼好處。 我建議此描述少於 150 個字符。

註冊 WordPress.org 帳戶

如果您還沒有 WordPress.org 帳戶(用於在支持論壇等中進行交互),您需要獲得一個。 只需訪問:https://login.wordpress.org/register

請求將您的新插件放入 WordPress 插件目錄

大多數帶有兼容許可證的合理插件都可以在 WordPress 插件目錄中獲得空間。

  1. 轉到:http://wordpress.org/extend/plugins/add/
  2. 填寫您的標題和描述
    (我告訴過你你需要那個!)
  3. 跳過此表單中插件的上傳——即使您的插件已準備就緒。

您的插件目錄請求由真人處理,因此可能需要一段時間。

為您的機器安裝 SVN 客戶端

要使用插件目錄,您的機器上需要一個 Subversion 客戶端。

  • 對於 Windows,我推薦 TortoiseSVN。
  • 對於 Mac,SCPlugin 似乎是一個不錯的軟件包。

只需選擇一個並安裝它。 關於這一點沒有太多可說的。

為您的項目選擇本地目錄

Subversion 將使用 WordPress 插件目錄使您的插件文件的本地副本保持最新。 我建議在您的本地計算機上創建一個目錄,您將在其中保存所有 Subversion 跟踪的項目。 注意:如果您在本地計算機上有 Web 開發環境,請不要試圖使用本地 Web 服務器的 WordPress 插件目錄作為您的項目目錄。

例如,如果您在插件文件夾所在的計算機上安裝了本地 WordPress:

documents/public_html/devdomain.com/wp-content/plugins/

…不要認為您可以使用該目錄來同步您的 WordPress 插件目錄項目。 那會給你帶來痛苦。

相反,創建一個像這個例子一樣的目錄:

documents/projects/wp-plugins-public/

您的每個插件項目文件夾都將位於“wp-plugins-public”中。 對於本教程,我將使用一個名為“content-scheduler”的插件文件夾。 因此,我將創建一個這樣的目錄:

documents/projects/wp-plugins-public/content-scheduler

您的插件請求批准電子郵件

一旦您的插件請求獲得批准,您將收到一封電子郵件,其中包含指向您的 SVN 存儲庫的鏈接。 這是專門針對那個插件的,是繼續進行 Subversion 同步所必需的。

本文的目錄條款

這篇文章中提到了這麼多不同的目錄、項目和文件夾,很容易讓人感到困惑。 在使用這個 Subversion 工作流時,讓我們在三個不同的位置上達成一致。

  1. 工作目錄
    這是您正在更改和測試的代碼的當前副本。 它應該位於開發 Web 服務器上的“/wp-content/plugins/”文件夾中。 在我的機器上,它恰好是:
    documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
  2. 項目目錄
    這是您的 Subversion 客戶端將與 WordPress 插件目錄保持同步的目錄。 在我的機器上,這是:
    documents/projects/wp-plugins-public/content-scheduler/
  3. 服務器目錄
    這指的是存儲在 WordPress 插件目錄中的項目。 這是公眾可以獲取您的插件的地方。 根位置稱為您的“SVN 存儲庫”,將在您的插件請求批准電子郵件中分配給您。 對於我的示例,這是:
    http://plugins.svn.wordpress.org/content-scheduler

將新的服務器目錄拉到您的本地計算機

即使您沒有在插件目錄中的新插件位置放置任何文件,您也需要將該目錄的副本下載到您的機器上。 這樣做會在幕後設置一些標誌,以幫助您的 Subversion 客戶端知道什麼是最新的,什麼不是。

  1. 右鍵單擊您的項目目錄插件文件夾。
  2. 選擇“SVN結帳”。
  3. 在第一個字段中輸入您的 WordPress SVN 存儲庫 URL(來自您的批准電子郵件)。
  4. 您的項目目錄插件文件夾應該在第二個字段中。
    由於您通過右鍵單擊該文件夾開始此過程,因此應該已經填充了該字段。
  5. 點擊“確定”

完成插件的開發

開發和測試你的插件。 這包括創建一個適當的“readme.txt”文件來配合它。 “readme.txt”文件不僅僅是一些關於你的插件的隨機註釋。 WordPress 插件目錄使用“readme.txt”文件的內容來了解您的插件的哪個版本被認為是最新的,並在目錄中構建插件頁面的內容。

  • 有關創建正確的“readme.txt”文件的更多信息,請參閱這個 WordPress readme.txt 示例。

“readme.txt”文件的一個重要部分是“Stable”標籤。 在開發插件時,請將此標籤保留為“主幹”。 一旦您發布了供公眾使用的版本,我們將使用正確的版本號對其進行更新。

向公眾提供您的第一個版本

更新項目目錄主幹

  1. 將工作目錄的內容複製到項目目錄的“trunk”文件夾中。
    就我而言,我正在從工作目錄複製插件的全部內容:
    /documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
    到我的項目目錄:
    /documents/projects/wp-plugins-public/content-scheduler/
  2. 右鍵單擊項目目錄中的“content-scheduler”插件文件夾,然後選擇“SVN Commit”。
  3. 如果需要,請為提交輸入註釋。
  4. 查看被視為新文件並將復製到服務器的文件列表。 如果此列表看起來準確,請單擊“確定”,文件將被複製到 wordpress.org 上的服務器目錄。

在服務器上標記新版本

您已經更新了“主幹”中的文件,但這不是公眾應該下載的內容。 您需要使用“標記”來創建“主幹”的副本。 此副本將不再更改,將提供給公眾使用。 對於這個例子,讓我們創建一個 1.0 版本。

  1. 右鍵單擊項目目錄的“trunk”文件夾並選擇“Branch/Tag”。
    對我來說,這是:
    /documents/projects/wp-plugins-public/content-scheduler/trunk/
  2. “To URL”位置字段將以“/trunk”結尾。 您需要將其更改為“/tags/1.0”以創建您的 1.0 版本。
  3. 如果需要,您可以添加有關此標記操作的註釋。
  4. 單擊“確定”,然後忽略任何有關“更改到此分支的重要...”的消息

使用新的標記版本更新本地項目目錄

您剛剛告訴服務器在“/tags/1.0”目錄中創建項目文件的新副本。 現在,我們需要使用該新標籤更新您的本地項目目錄。

這個過程可能看起來很奇怪。 您可能想知道為什麼不能在本地“/tags/1.0”目錄中製作自己的副本。 如果你這樣做,服務器目錄和項目目錄可能會變得混亂和混淆什麼是更新的,什麼不是。

  • 再次右鍵單擊項目目錄並選擇“SVN更新”。
    這會將更改從服務器目錄拉到本地項目目錄。 在這種情況下,更改是添加文件的“/tags/1.0”副本。

更新 readme.txt 穩定標籤

所有正確的文件都已準備好供公眾使用您的插件。 但是,我們必須告訴插件目錄公眾應該使用哪個標記版本。

  1. 編輯本地項目目錄的“trunk”文件夾中的“readme.txt”文件。
    對我來說,這是以下內容:
    /documents/projects/wp-plugins-public/content/scheduler/trunk/readme.txt
  2. 將“穩定標籤”更改為您的發布版本,“1.0”
  3. 保存文件
  4. 右鍵單擊剛剛更新的“readme.txt”文件,然後選擇“SVN Commit”。

就是這樣! 在 15 分鐘左右:

  1. WordPress 插件目錄將更新您的項目列表
  2. “1.0”將被視為穩定標籤
  3. “/tags/1.0/readme.txt”中的信息將用於填寫您的項目頁面。

插件的新發展

最有可能的是,您將對插件進行改進並需要發布它們。 這是它的工作原理。

  1. 對工作目錄中的插件進行更改。
    這些更改應根據需要包括對 readme.txt 文件的更改,例如更改日誌條目。
  2. 將工作目錄中的更改複製到本地項目目錄中。
  3. 確保 readme.txt 文件具有當前公共版本的正確“穩定”標籤。
  4. 右鍵單擊項目目錄並選擇“SVN Commit”以將新的主幹更改放入服務器目錄。
  5. 右鍵單擊項目目錄中的“trunk”目錄並選擇“Branch/Tag”以創建新的版本標籤以進行發布。 (確保“在存儲庫中創建副本:”設置為“工作副本”。)
  6. 右鍵單擊項目目錄並選擇“SVN 更新”以從服務器目錄中下拉標籤更改。
  7. 更新項目目錄的“/trunk/readme.txt”文件中的穩定標籤以匹配您創建的新發布標籤。
  8. 右鍵單擊項目目錄(是的,再單擊一次)並選擇“SVN Commit”以將更新後的 readme.txt 文件發送到服務器。

呸。 就這樣!

您是否將任何插件上傳到 WordPress 插件目錄? 在下面分享您的經驗和評論。
標籤: