Добавляем плагины в каталог WordPress.org

26.06.2007 – 8:08 пп

Автор: Ronald Huereca, Перевод: Александр Бишоп

От переводчика: Этот перевод не является полным, откровенную «воду» я просто вылил, а предложения, которые нельзя было перевести дословно, перефразировал.

Это руководство рассчитано на пользователей Windows, но в будущем я добавлю руководства для пользователей других систем, как только они появятся. Каталог WordPress использует систему Subversion, которая подробно здесь рассматриваться не будет (Вам не нужно разбираться в Subversion, чтобы использовать это руководство). В нём описано, как добавить плагин Feed Styler, который я написал, в каталог. Я заранее извиняюсь [за плагин], но я хочу предоставить Вам пошаговое описание процесса добавления в каталог реальных плагинов.

1. Регистрация на WordPress.org

Отправляйтесь на страницу поддержки WordPress и зарегистрируйте пользователя. Вы должны быть зарегистрированы, чтобы добавлять плагины в каталог.

2. Добавление плагина

Следующий шаг — добавление плагина. Вам необходимо предоставить:

  • Название плагина.
  • Его описание в одно или два предложения.
  • Домашнюю страницу плагина (необязательно).

3. Ожидание подтверждения

Процесс подтверждения не является мгновенным. Первый мой плагин подтвердили через неделю, а второй почти через две.

После этого Вы получите email, в котором будет сказано, что Ваш плагин подтверждён, и в ближайшем будущем Вы получите доступ к репозитория Subversion. В моём случае репозиторий находится тут: http://svn.wp-plugins.org/feed-styler/

Вам так же рекомендуют использовать Ваши имя пользователя и пароль для WordPress.org для доступа к репозиторию.

4. Установка TortoiseSVN

Идите на страничку TortoiseSVN и скачайте версию для Вашей операционной системы (извините, пользователи операционных систем, отличных от Windows). Установка проходит без проблем, но после нее необходима перезагрузка компьютера.

wpp1.jpg

5. Создание папки

Создайте папку для синхронизации Вашего репозитория. Для этого руководства я создал папку прямо на моём рабочем столе и назвал ее ‘feed styler’.

wpp2.gif

6. Делаем Check Out репозитория

Заходим в созданную папку и кликаем правой кнопкой мыши для того, чтобы появилось контекстное меню с настройками TortoiseSVN. Вам необходимо выбрать пункт SVN Checkout.

wpp3.gif

После того, как Вы выбрали SVN Checkout, появится диалог, в котором необходимо будет ввести URL репозитория и место его хранения (синхронизации). URL Вашего репозитория — тот самый, который был выслан Вам в письме, когда Ваш плагин был подтверждён Путь к папке для его хранения уже заполнен. После заполнения обоих полей просто нажмите OK.

wpp4.gif

Если Вы всё сделали правильно, в папке должно появиться три подпапки — branches, tags, и trunk.

7. Подготовка Read Me файла

Сначала нужно приготовить Ваши файлы для добавления в репозиторий. Обычно от Вас требуется только приготовить Read Me файл, который соответствует требованиям WordPress.org. Это не простое занятие, но имеется скрипт для проверки, который значительно облегчит Вашу жизнь.

Несколько советов по подготовке:

  • Используйте правильные теги, чтобы пометить Ваш плагин.
  • Readme должен находиться в главной папке плагина.
  • Файлы с иллюстрациями должны иметь названия screenshot-1, screenshot-2, screenshot-n, и т.д.
  • Используйте скрипт проверки Readme файла.
  • Со стабильными тегами не стоит оригинальничать. Используйте что-нибудь вроде: Stable tag: 1.0.5.0.

8. Копирование файлов плагина в папку Trunk

Как только вы подготовили файлы плагина и readme файл, скопируйте из в папку trunk. Основной файл плагина и файл readme должны оба лежать в корне папки trunk.

Вот так выглядит папка trunk в случае с плагином Feed Styler:

wpp5.gif

9. Делаем Commit файлов в репозиторий

Нажимаем правой кнопкой мыши на папке trunkб чтобы появилось контекстное меня TortoiseSVN. Выбираем SVN Commit.

wpp6.jpg

После этого появится диалог с возможностью ввода комментария и выбора файлов, которые Вы хотите поместить в trunk. Введите короткий комментарий (например “Adding my plugin version”) и выберите все файлы, которые Вы хотите добавить.

wpp7.jpg

После этого нажмите OK. Появится окно для ввода имени пользователя и пароля. Вам необходимо ввести имя пользователя и пароль для форума сайта WordPress.org (см. Шаг 1).

wpp8.jpg

Если Вы всё сделали правильно, Ваш плагин будет добавлен.

wpp9.jpg

10. Создаём тег для релиза

Вот сейчас и понадобится readme файл. В нем Вы уже указали тег стабильного релиза (в моём случает это 1.0.5.0). Сейчас необходимо указать тег, который будет соответствовать стабильному тегу из readme файла.

Нажмите правой кнопкой мыши на папке trunk и выберите TortoiseSVN » Branch/Tag.

wpp10.jpg

В появившемся диалоге введите путь к папке tag и номеру стабильной версии. В моём случае это будет: http://svn.wp-plugins.org/feed-styler/tags/1.0.5.0

Так же напишите короткий комментарий: “Tagging this release.”, например. Нажмите кнопку OK.

wpp11.jpg

Если Вы всё сделали правильно, плагин должен быть «затегирован». Если Вы хотите обновить свои папки локально, нажмите на папке tags правой кнопкой мыши, и выберите SVN Update.

11. Убедимся, что плагин отображается правильно и в репозитории, и в каталоге WordPress

Есть несколько путей проверить, что Вы всё сделали правильно. Первый путь — проверить Ваш URL subversion (в моём случае это: http://svn.wp-plugins.org/feed-styler/) и убедиться, что trunk и tags были загружены успешно.

После загрузки начальный trunk и tags, каталогу WordPress необходимо около 15 минут на обновление. Откройте страничку плагина в каталоге (в моём случае: http://www.wordpress.org/extend/plugins/feed-styler) и проверьте, всё ли правильно отображается в readme. Если Вам необходимо внести изменения в readme файл, просто отредактируйте его локально, нажминет правой кнопкой мыши на файле и выберите “SVN Commit.”

Если вы всё сделали правильно, Вы должны увидеть Ваш плагин на главной странице каталога.

wpp12.gif


9 Responses to “Добавляем плагины в каталог WordPress.org”

  1. Спасибо, очень интересная статья. Надеюсь, дойдут руки до своего плагина, я приведу его в божеский вид и выложу в репозиторий.

    P.S.: А Хабр зря обидели…

  2. вам спасибо, что дочитали.

    а по поводу хабра — на обиженных воду возят — это раз. да и не собирался я никого обижать — это два ;-)

  3. […] когда я пытался запостить в тамошний блог о WordPress вот эту статью, мне просто не хватило для этого кармы. Тогда я […]

  4. Спасибо за статью, отличная работа.
    Для гостей сайта — доступна offline версия для скачивания по адресу: http://download.infine.ru/man/add-plugin-to-wordpress.org-svn-repository.zip (pdf, 231 Kb)

  5. Просто незаменимая статья про SVN и wordpress. Только что опубликовал свой плагин руководствуяь этой статьёй ))

    Спасибо!

  6. Мой пока первый плагин (не первый как таковой), а первый в оф. репозитории WP подтвердили через несколько часов после подачи заявки. Удивился, что так быстро. Сам письмо прочёл только на следующий день.

  7. Мой пока первый плагин (не первый как таковой), а первый в оф. репозитории WP подтвердили через несколько часов после подачи заявки. Удивился, что так быстро. Сам письмо прочёл только на следующий день.

Прокомментировать