Освоение контроля версий: Практическое руководство по Git и GitHub для разработчиков

Жизнь программиста и так достаточно сложна. Почему бы не облегчить её, передав контроль версий ваших проектов специализированным сервисам? Большинство программистов в IT мире знакомы с Git, но для некоторых OT-программистов в этом сообществе это совершенно новая концепция. Когда работаете с разными коллегами над одним проектом, обмен кодом становится еще большей проблемой, а сервис вроде GitHub упрощает совместную работу над одним кодом. Этот блог проведет вас через первые шаги использования Git и GitHub для поддержания вашего кода и проектов в порядке.

---

В этом блоге я буду использовать GitHub и GitHub Client для Windows, но обратите внимание, что есть и другие варианты, включая GitLab. Мне просто нравится простота использования GitHub Client!

---

Настройка репозитория на GitHub

Шаг 1 — Скачайте и установите GitHub Client для Windows

На самом деле, первым шагом было бы создание аккаунта GitHub, но это немного выходит за рамки этого блога.

1. Клиент можно скачать здесь.
2. Следуйте руководству по установке
3. Войдите в свой аккаунт GitHub

Шаг 2 — Создайте папку или репозиторий для вашего проекта

Репозиторий — это место для жизни вашего проекта. Создавайте одну папку для каждого проекта! Каждый раз, когда что-то меняется в этой папке, GitHub Client это обнаружит, и вы сможете сохранить или отправить (push) ваши изменения в онлайн-репозиторий на GitHub.

1. Нажмите «Create a New Repository on your hard drive …»
2. Дайте вашему новому репозиторию имя и описание.
3. Вы можете изменить путь для репозитория, если хотите, или оставить как есть (ленивый способ)
4. Нажмите «Initialize this repository with a README» (Ленивый не значит, что не нужно следовать лучшим практикам и документировать код!)
5. Создайте репозиторий

Шаг 3 — Создайте проект PLCnext

Git отлично работает с текстовыми файлами. К счастью, в PLCnext Engineer есть опция сохранить проект как множество текстовых файлов, идеально подходящих для Git и нашего GitHub Client!

1. Откройте PLCnext Engineer и начните создавать проект как привыкли.
2. Когда будете готовы сохранить проект, выберите Save Project As (F12)
3. Перейдите в ваш GitHub репозиторий (по умолчанию: This PC/documents/GitHub)
4. Сохраните проект как «Uncompressed Project»

Шаг 4 — Закоммитьте изменения

Чтобы «сохранить» изменения в репозитории, нужно закоммитить их в ветку. Что такое ветка, я объясню позже, а пока просто запомните: нужно закоммитить изменения в ветку, чтобы сохранить их.

Дайте вашему коммиту название и краткое описание, чтобы вы могли помнить, что именно изменилось!

Шаг 5 — Опубликуйте или отправьте (Push) ваш репозиторий

Финальный шаг для создания онлайн-репозитория — отправить (push) наш локальный репозиторий на GitHub. Это так же просто, как нажать кнопку или нажать (ctrl + p). Выберите, должен ли ваш код быть приватным и принадлежать вам или организации.

Шаг 6 — Документируйте!

Нажмите (Ctrl + shift + G) для просмотра репозитория онлайн на GitHub в браузере. Вот он — ваш PLCnext проект на GitHub. Помните «Initialize README»? Это тот текст, который вы сейчас видите перед собой. В README.md вы должны объяснить структуру проекта, его цель и, возможно, контактную информацию для будущего обращения.

Пока сделайте некоторые изменения в файле README.md, нажав на карандаш. Файл «написан» на MarkDown, больше информации о MarkDown можно найти здесь.

Если вы сделали изменения, снова закоммитьте в ветку master!

Шаг 7 — Подтяните (Pull) изменения в ваш локальный репозиторий

Windows Client обнаружит, что в репозитории на GitHub были сделаны изменения. Не забудьте подтянуть (pull) изменения, чтобы снова начать работать с последней версией!

---

Советы и трюки

Issue Tracker

У GitHub замечательный трекер задач (issues), используйте его для отслеживания известных проблем в вашем ПО и обсуждения решений с другими заинтересованными сторонами.

Projects

Используйте встроенную Project Board для отслеживания задач с канбан-доской. Если хотите, можно автоматизировать канбан с встроенными триггерами, чтобы сделать жизнь еще проще.

Branches (Ветки)

Ага, вот мы и тут. Видите, я говорил, что объясню, что такое ветки! Ну, я пусть GitHub объяснят, что такое ветки …

Собираетесь сделать много изменений или внедрять новую функцию? Создайте ветку, чтобы изолировать ваши изменения и влить (merge) вашу «feature branch» в master branch с помощью pull request.

Release (Релиз)

Готовы развернуть проект? Создайте релиз, чтобы добавить его в ваш AS Build!