Деплой проекта на сервер из Github

При разработке проектов локально есть необходимость выгружать изменения на сервер. Просто взять и выгрузить всё сразу недостаточно, обычно нужно еще запустить какие-то скрипты, вроде обновления зависимостей и миграций.

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

А потом я наткнулся на ранее неизвестные мне возможности Git — его хуки.

Читаем документацию и видим, что

Хук post-merge запускается после успешного выполнения команды merge. Его можно использовать для восстановления данных в рабочей директории, которые Git не может отслеживать, такие как права доступа. Так же этот хук может проверять наличие внешних по отношению к Git файлов, которые вы захотите скопировать при внесении изменений.

А это значит, что мы можем запускать любые произвольные скрипты при успешном скачивании изменений из Git. Так что нам нужно сделать 6 простых шагов:

1. Генерируем SSH ключ для Github

ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

сохраняем его в какую-нибудь временную директорию с именем id_rsa. Не затрите случайно свой основной ключ в системе!

Я сохраняю в директорию Downloads.

2. Добавляем публичную часть ключа в репозиторий своего проекта
Нам нужно вставить содержимое id_rsa.pub в настройки Deploy Keys проекта на Github:

cat ~/Downloads/id_rsa.pub

Allow write access не отмечаем! нам же не нужно, чтобы при взломе хостинга была возможность что-нибудь натворить с репозиторием проекта, правда?

3. Устанавливаем приватную часть ключа юзеру хостинга
Нужно скопировать содержимое cat ~/Downloads/id_rsa на своём компе и вставить в nano ~/.ssh/id_rsa на хостинге. Если на хостинге уже есть какой-то основной ключ у юзера — не затрите его! Лучше поищите как сохранять несколько ключей и использовать их раздельно для разных подключений.

Еще нужно указать строгие права на свой ключ: chmod 600 ~/.ssh/id_rsa

4. Скачиваем этот репозиторий в рабочую директорию сервера
Ну тут просто git clone git@github.com:username/project.git — смотрите точнее у себя на Github. Главное, чтобы доступ был именно по SSH — мы же для него ключ и установили.

Лично у меня каждый проект на сервере под своим юзером и в своей рабочей директории, поэтому я и скачиваю его в корень этой директории. Если Git будет ругаться, что файлы уже существуют, то нужно сделать pull во временную директорию, а потом перенести всё оттуда в корень, включая скрытую .git.

Вот так это выглядит в итоге:


Смысл в том, чтобы дальше вы могли делать git pull из корня проекта, и это бы обновляло все ваши файлы в нём из репозитория.
В принципе, подобная возможность скачивания обновлений уже решает некоторые проблемы, например когда из-за неустойчивого соединения при выгрузке из PhpStorm, весь сайт падает от того, что половина файлов новая, а другая еще нет.

5. Но мы идём дальше и создаём наш хук post-merge:

nano ~/.git/hooks/post-merge

Где пишем что-то вроде

#!/bin/bash

/usr/bin/composer install --working-dir ~/core --no-dev
php ~/core/vendor/bin/phinx migrate -c ~/core/phinx.php
cd ~/frontend && ./node_modules/.bin/yarn install
cd ~/frontend && ./node_modules/.bin/yarn build
cd ~/frontend && ./node_modules/.bin/yarn restart

Ну или какие у вас там скрипты? Вот их и пишите.

Теперь при успешном git pull, когда есть какие-то изменения, будут запускаться эти команды.

6. Осталось только добавить проверку в cron

crontab -e

И пишем

MAILTO=your_email@example.com

*/30 *     * * *    git pull

И тогда каждые 30 минут будет проверяться ваш репозиторий.

Вам нужно только пушить ваш протестированый код в основную ветку на Github, откуда его загрузит рабочий сервер, а хук post-merge запустит ваши скрипты. Отчеты об успешной работе или об ошибках (если таковые будут) прилетят на почту, указанную в MAILTO — их пришлёт сам cron.

При таком подходе вся работа производится через Git, вы сами не лезете на сервер, и не вносите там никаких изменений вручную. Это гарантирует, что в продакшне у вас всегда ровно тот код, который вы выгрузили в основную ветку.

Лично мне такая простая настройка проектов очень сильно облегчает жизнь уже полгода. Никаких недостатков за это время я не нашёл, так что делюсь этим способом с вами.