Публикация плагина в репозитории wordpress.org
Мы закончили разработку первой версии плагина BS Scroll Progress. Теперь нас ждет публикация плагина в репозитории wordpress.org.
Подготовка к публикации
Настоятельно рекомендую прочитать подробные инструкции по публикации плагинов. Там можно узнать, что разрешается, и что запрещено использовать в плагине. Это поможет миновать проблем при рассмотрении плагина.
Убедимся, что первая версия плагина полностью готова. Если требуется что-то исправить, нужно это сделать прямо сейчас. Код плагина будет проходить проверку после отправки в течение нескольких дней. В зависимости от принятого решения плагин либо появится в репозитории wordpress.org, либо вернется на доработку. Будем надеяться, что наш плагин проверку пройдет.
Если все в порядке, можно переходить к заполнению README.txt. Это важный файл, содержащий информацию для отображения страницы плагина в репозитории wordpress.org. Здесь указываются название плагина, его описание, часто задаваемые вопросы, история версий и т.д.
Есть строго определенный формат этого файла для плагинов WordPress. Кстати, WordPress Plugin Boilerplate, о котором я рассказывал в прошлой статье, уже содержит его.
Если вы пишите свой плагин с нуля, то пример README.txt ищите здесь.
Можно проверить файл валидатором перед отправкой, чтобы избежать ошибок.
На основе шаблона из WordPress Plugin Boilerplate у меня получился такой README.txt:
=== BS Scroll Progress ===
Contributors: neuropassenger
Donate link: https://neuropassenger.ru
Tags: scroll, bar
Requires at least: 4.5
Tested up to: 5.7
Stable tag: 1.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
This plugin adds a small colored scroll bar to the top of site pages.
== Installation ==
This section describes how to install the plugin and get it working.
1. Unzip `bs-scroll-progress.zip` to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Customize the Progress Bar using Plugin Settings. Specify the selector with the main content, the color and the width of the Progress Bar.
== Frequently Asked Questions ==
= Can multiple selectors be added? =
At the moment, only one selector is working correctly. But the ability to add multiple selectors is planned for the future.
== Changelog ==
= 1.0 =
* Release version.
== Upgrade Notice ==
= 1.0 =
First stable version.
Code language: plaintext (plaintext)Обратите особое внимание на строчку 2. Здесь указываются контрибьюторы, их имена должны совпадать с именами пользователей на wordpress.prg.
Теперь можно сформировать zip-архив bs-scroll-progress.zip для отправки на рассмотрение.
Публикация плагина в репозитории wordpress.org
Нас ожидает увлекательный процесс публикации:
- Залогинимся на wordpress.org.
- Отправим плагин на рассмотрение.
- Через несколько дней (у меня это заняло 3 дня) получим результат. Плагин либо будет утвержден, либо потребуется доработать его. Об этом сообщат в письме.
Мне повезло. Мой плагин утвердили без доработок.
- Примерно через час после утверждения откроется доступ к SVN репозиторию. Он нужен для размещения файлов плагина.
- Загрузим плагин в репозиторий с корректным README.txt.
И после этого сможем найти наш плагин в обозревателе плагинов WordPress.
Subversion (SVN)
Приступим к загрузке в репозиторий.
Я работаю в MacOS, поэтому устанавливал SVN для этой операционки. Изначально у меня его не было. Проще всего это сделать в терминале с помощью homebrew:
brew install subversionCode language: Bash (bash)Перейдем к работе с самим репозиторием. В процессе у нас спросят логин и пароль. Нужно использовать user id с wordpress.org и пароль оттуда же.
Создадим локальную директорию для нашего репозитория с плагином и перейдем в нее:
cd /Volumes/Storage/dev/wordpress.org/plugins/bs-scroll-progressCode language: Bash (bash)Вернемся чуть выше:
cd ../Скопируем удаленный репозиторий к себе:
svn co https://plugins.svn.wordpress.org/bs-scroll-progress bs-scroll-progressCode language: Bash (bash)В нашей локальной директории появится 3 папки:
- /trunk/ — актуальная версия плагина на данный момент
- /assets/ — дополнительные материалы плагина: скриншоты, баннеры и т.д.
- /tags/ — версии плагина (как правило мажорные)
Файлы плагины необходимо добавить в /trunk/.
В /trunk/ должны сразу располагаться файлы плагина, никаких архивов и поддиректорий использовать нельзя.
После того, как мы скопировали файлы плагина в локальную папку /trunk/ (например, с помощью Finder), нужно отправить их в репозиторий. Добавим все файлы из /trunk/ в SVN и сделаем коммит первой версии.
svn add trunk/*
svn ci -m "Release version"Спустя некоторое время плагин появится в репозитории wordpress.org.
Как видите, опубликовать плагин на wordpress.org довольно просто, если следовать подробным инструкциям. Теперь можно заниматься дальнейшей разработкой плагина и его поддержкой.
А вы уже размещали свои плагины? Делитесь в комментариях!
Спасибо за плагин. Но как его заставить работать в записях? Кроме настроек стилей ничего не нашел.
Приветствую! Нужно в настройках плагина указать CSS селектор элемента, внутри которого находится основной контент записи. Если покажите пример поста со своего сайта, смогу подсказать, что именно там нужно ввести.