С чего начать: Работа с GitHub

Перейти к содержанию​

Основы работы с GitHub

Честно говоря об этом я я не планировал рассказывать, но поскольку всё равно решил залить код нашего плагина на GitHub, то почему это не продемонстрировать всем?

В первую очередь, я хочу отметить, что на мой взгляд, работа с гитхабом в IntelliJ IDEA, гораздо проще и понятнее чем в Eclipse. Я многие свои плагины, написанные на Eclipse для bukkit, заливал на GitHub, но более менее продуктивная работа (в т.ч. с участием в других проектах) у меня получилась только когда я перешёл на IDEA.
Возможно мне просто не везло (а кто-то скажет, что всё дело в кривости рук), но когда я пользовался Eclips'ом, у меня регулярно возникали различные дурные и необъяснимые проблемы, которые решились шаманскими способами. В IDEA — тьфу-тьфу-тьфу — всё работает как часы!

Зачем вообще нужно заливать код на GitHub?
GitHub — это сервис для хостинга исходного кода, позволяющий обеспечивать их совместную разработку. То есть, используя GitHub, Вы можете не только продемонстрировать исходный код Вашего плагина, но и принять помощь в его разработки. Или наоборот, помочь кому-то, реализовав ту или иную функцию, которая изначально не предусмотрена проектом.
И что особено важно, интересный проект размещенный, на GitHub не умрёт, даже если разработчик потеряет к нему интерес. К примеру Выйдет очередная версия API Nukkit, а создателю плагина уже неинтересен ни сам плагин ни майнкрафт вообще — найдутся другие разработчики, которые подхватят знамя и продолжат разработку.
Кстати, помимо хранилища исходного кода, GitHub позволяет привязать к проекту wiki-документацию, а также обладает встроенной системой сообщений об ошибках (issues), что позволяет значительно упростить общение разработчика плагина и пользователей.

Заливаем проект на GitHub
Надеюсь Вы уже зарегистрированы на github.com. Если нет, то самое время это сделать

Ну а в IDE нужно сделать следующее. Открыть проект и перейти в пункт меню VCS/Import into Version Control/Share Project on GitHub



IDEA запросит пароль от GitHub.



После этого нужно ввести название проекта (оно может отличаться от названия проекта в IDEA), а также указать краткое описание.



После этого нужно будет определить какие именно файлы нужно заливать на GitHub.



Весь проект заливать смысла нет. Досточно отправить только то, что потребуется для воссоздания плагина. В первую очередь это исходный код и файл plugin.yml. Ну и все ресурсы, которые участвуют в проекте (языковые файлы, шаблон файла config.yml). И, если есть, файл pom.xml.



Жмём "Ок" и...



После этого можете пройти на github.com и убедиться, что Ваш проект там появился.



Кстати, проекту не помешает добавить описание. Ждём кнопку "Add a README", набираем описание и давим кнопку "Commit new file".



После этого можно подгрузить описание с гитхаба в проекта IntelliJ IDEA. Для этого переходим к проекту, открытому в среде разработки, и давим кнопку "Update project"



Объединяем проект с гитхаба с локальной копией

 

И наслаждаемся сообщением об успешном выполнении



Файл README.md действительно появился в проекте (при открытии будет предложен плагин для установки - устанавливайте, получите проверку синтаксиса и возможность проверять как он будет выглядеть прямо в IDE)



Файл README.md можно отредктивровать и отправить обратно в GitHub.



Появится окно, в котром надо будет ввести описание изменений (не скупитесь на описание, старайтесь чтобы оно было полным) и нажать на кнопку Commit/Commit and Push.



Вот и всё! — Измененные файлы попали на GitHub

---

Подключение стороннего проекта с GitHub

Мы успешно залили исходный код плагина на GitHub. А вот если Вам потребуется обратная процедура - получение исходного кода другого плагина, то всё будет выглядеть примерно так:

Надо найти интересующий Вас проект на GitHub'е и нажать на кнопку "Fork".


После этого, в списке ваших проектов появится и тот, который вы "форкнули".

Это даст Вам возможность создать в IntelliJ IDEA, проект на основе кода, размещенного на гитхабе. Для этого надо воспользоваться пунктом меню File/New/Project from Version Control/GitHub



Появится окно, в котором надо будет выбрать проект из имещихся в Вашем профиле на GitHub. Выбрав - нажимаем кнопку "Clone".



После этого, у Вас появится новый проект на основе исходного кода размещенного полученного с GitHub'а.
Если этот код писался в idea (и у него совпадает файловая структура с обычными проектами) idea, то у Вас не возникнет ни каких проблем с импортом проекта.

Обычно директории проекта выглядят так:



Если после клонирования проекта у Вас всё так и есть, а в папка java и resources лежит исходный код и plugin.yml, соответственно, то дальше читать не нужно - у Вас всё как надо.

Если нет, то придётся рассказать IDEA где у Вас что лежит — придётся обозначить папки где находится исходный код, а где ресурсы.
Если это Ваш личный проект и Вы хотите полностью перенести его в IDEA, то можно просто создать соответствующие папки (src/main/java и src/main/resources), переместить туда файлы.

Для этого нужно будет перейти в раздел "Структура проекта



А там, перейти к настройке модулей.


Здесь нам нужно совершить следующие манипуляции:

• Выделить папку, где находится исходный код и нажать кнопку Sources (в строке Mark as
• Выделить папку, где находятся ресурсы и нажать кпноку Resources (в той же строке )

После этого, Вы сможете редактировать и компилировать код как обычно.

Отправка изменений кода на GitHub производится точно также (собственно это одна и та же операция), как мы отправляли изменения файла README.md.

 

@Fi3iK(ZeleninGerman)
Ну я надеюсь, это прочитают ещё и те, кто как я долго когда-то, привыкли к Eclipse. Если бы в свое врёмя я прочитал что-то похожее, то скорее всего перешёл бы на IDEA гораздо раньше.