Как выкладывать свои модули на drupal.org: руководство новичка

Главные вкладки

ivnish 30 ноября 2018 в 9:55
5

Итак, вы решили поделиться своим модулем с сообществом, но не знаете с чего начать? Давайте разбираться вместе.

1. Для начала нужно завести аккаунт на drupal.org. Это обычная процедура, как и на многих сайтах.

2. Попав в личный кабинет, нужно перейти в раздел Your Projects и там уже есть ссылка Add a new project.

3. Создайте страницу проекта. Выбирайте Full Project, больше нет смысла выбирать Sandbox. Как её оформлять можно посмотреть у других проектов, ведь наверняка вы часто бываете на страницах других контрибных проектов? Не нужно писать слишком много и делать из страницы «пестрящую новогоднюю ёлку», лучше кратко и по делу.

4. Для того, чтобы работать со своими проектами без паролей, вам понадобится SSH ключ. Загрузить свой ключ можно в своем профиле во вкладке SSH keys.

5. Вы создали проект, теперь нужно загрузить файлы в git-репозиторий. На странице проекта нужно пройти на вкладку Version control и следовать инструкциям. Вам придется или создать у себя новый репозиторий, если его нет, или загрузить на drupal.org уже готовый репозиторий с вашими коммитами. Я надеюсь, вы уже освоили git?

6. Там же вам подскажут как создать dev-ветку в git. Если модуль для Drupal 7, то ветка должна называться 7.x-1.x, если модуль для Drupal 8, то 8.x-1.x. Обязательно удалите ветку master!

7. Смысл dev-ветки вот в чем: все изменения поступают только в дев-ветку. Это как бы роллинг-альфа-версия модуля, в которой всегда есть свежие изменения. Когда вы понимаете, что модуль созрел, пусть даже для бета-версии, вам нужно создать в git тег, например 8.x-1.0-beta1, этот тег и будет названием вашего релиза. Возможны варианты: 8.x-1.0-alpha2, 8.x-1.0-rc7, ну и 8.x-1.0.

8. Релизный тег вы создали, теперь нужно создать сам релиз. В самом низу проекта есть ссылка Add new release.

9. Что обязательно нужно сделать в настройках проекта (вкладка Edit): выбрать Default branch, во вкладке Releases выбрать рекомендуемый релиз. У вас в проекте появится примерно такой вид:

10. Для солидности можно пометить модуль «зеленым щитом», об этом есть отдельная статья.


Дополнительная информация (на английском языке).

  1. Форма создания проекта https://www.drupal.org/node/add/project-module
  2. Лучшие практики создания и поддержки проекта
  3. Создание ветки и тега в git-репозиториии проекта
  4. Соглашения об именовании релизов

Автор

ivnish Drupal FullStack Developer

Комментарии

Аватар пользователя gun_dose gun_dose 30 ноября 2018 в 10:39
1

Маленькое дополнение:
во-первых, свежесозданному аккаунту могут не дать прав на создание модуля. Там есть какая-то роль, типа подтверждённый пользователь. На неё можно подать заявку. Но если у вас есть несколько созданных issues, какое-то количество комментариев и т.д., то вероятно это роль вам уже была присвоена автоматически.
во-вторых, перед тем, как будете пушить свой проект в репозиторий, удалите ветку master - она не нужна и потом будет только вызывать путаницу.

Аватар пользователя bumble bumble 30 ноября 2018 в 18:10
3

Пара полезных ссылок:

  1. Тут, вроде, все о модуле, тогда ссыль на создание лучше эта.
  2. Лучшие практики создания и поддержки проекта
  3. Создание ветки и тега модуля (еще более удобным будет ссылка после создания проекта, вида drupal.org/project/<PROJECT-NAME>/git-instructions )
  4. Соглашение об именовании