Использование Subversion с каталогом плагинов WordPress

Следуйте этим пошаговым инструкциям, чтобы добавлять и обновлять плагины в общедоступном каталоге плагинов 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. Предупреждение: Если на вашем локальном компьютере есть среда веб-разработки, не поддавайтесь искушению использовать каталог плагинов 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. Рабочий каталог
   Это текущая копия кода, который вы изменяете и тестируете. Он должен находиться в папке «/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. Введите URL-адрес вашего репозитория WordPress SVN (из вашего электронного письма с подтверждением) в первое поле.
4. Папка плагина каталога вашего проекта должна быть во втором поле.
   Поскольку вы начали этот процесс, щелкнув правой кнопкой мыши эту папку, это поле уже должно быть заполнено.
5. Нажмите «ОК»

Завершите разработку вашего плагина

Разработайте и протестируйте свой плагин. Это включает в себя создание соответствующего файла «readme.txt». Файл «readme.txt» — это не просто случайные заметки о вашем плагине. Каталог плагинов WordPress использует содержимое файла «readme.txt», чтобы понять, какая версия вашего плагина считается текущей, а также для создания содержимого страницы вашего плагина в Каталоге.

• Для получения дополнительной информации о создании правильного файла «readme.txt» см. этот пример WordPress readme.txt.

Важной частью вашего файла «readme.txt» является тег «Стабильный». Пока вы разрабатываете свой плагин, оставьте этот тег равным «trunk». Как только вы выпустите версию для общего пользования, мы обновим ее, указав правильный номер версии.

Сделайте свою первую версию общедоступной

Обновление ствола каталога проекта

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. Поле местоположения «К URL» будет заканчиваться на «/trunk». Вам нужно изменить это на «/tags/1.0», чтобы создать версию 1.0.
3. Вы можете добавить примечание об этой операции пометки, если хотите.
4. Нажмите «ОК» и игнорируйте любые сообщения о том, что «важно перейти на эту ветку…»

Обновление локального каталога проекта новой версией с тегами

Вы только что сказали серверу сделать новую копию файлов вашего проекта в каталоге «/tags/1.0». Теперь нам нужно обновить локальный каталог проекта с помощью этого нового тега.

Этот процесс может показаться странным. Вы можете задаться вопросом, почему вы не можете просто сделать свою собственную копию в вашем локальном каталоге «/tags/1.0». Если вы сделаете это, каталог сервера и каталог проекта могут запутаться и запутаться в том, что обновлено, а что нет.

• Щелкните правой кнопкой мыши каталог проекта еще раз и выберите «Обновление SVN».
  Это извлекает изменения из каталога сервера в локальный каталог проекта. В этом случае изменение представляет собой добавление копии «/tags/1.0» ваших файлов.

Обновление стабильного тега readme.txt

Все нужные файлы готовы для публичного использования вашего плагина. Тем не менее, мы должны сообщить каталогу плагинов, какую версию с тегами должен использовать публичный доступ.

1. Отредактируйте файл «readme.txt» в папке «trunk» вашего локального каталога проекта.
   Для меня это следующее:
   /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.org