Развертывание с GitHub на сервер
GitHub, равно как и система контроля версий Git, на которой он основан, это фантастические инструменты для организации работы и взаимодействия в проектах, независимо от того, связаны эти проекты с кодом или нет.
В этой статье мы рассмотрим способы, позволяющие улучшить интеграцию Git и GitHub в рабочий процесс разработчиков, облегчая и механизируя процесс развертывания.
Я разделил все эти способы по типам используемых инструментов: отдельно инструменты для автоматического тестирования и отдельно проверяющие развертывание на сервере.
Зачем это нужно
Автоматизация этих процессов позволит вам и вашей команде сфокусироваться на создании, согласовании и объединении кода вместо того, чтобы тратить часы на развертывание и прочие повторяющиеся задачи при каждой новой сборке или изменении.
Недостатки автоматизации
Основная проблема с автоматическим развертыванием изменений это и есть автоматическое развертывание изменений. У вас должна быть уверенность в своей команде и в написанном коде. Именно поэтому автоматическое развертывание обычно совмещается с автоматическим тестированием и это отразилось на представленных ниже инструментах.
Конечно, это также означает, что все небольшие вопросы должны решаться одинаково быстро. Автоматизация должна сочетаться с коммуникацией. Если отправка в репозиторий основной ветки может запускать процесс сборки, то должно быть понятно, когда это происходит и кто может это вызвать.
Первоначальная настройка автоматизации может занять некоторое время. Важно заранее подумать о том, действительно ли это необходимо вашей команде и вашему рабочему процессу. Добавьте количество времени, которое вы тратите на тестирование и развертывание новых сборок — и если это занимает больше нескольких минут каждый раз, то оно того стоит.
Хуки Git
В Git есть набор встроенных хуков (или перехватчиков), которые могут быть использованы для автоматизации и обычно они являются первой остановкой для выполнения каких-либо задач после действий Git. Хуки делятся на серверные и клиентские.
Хуки с серверной стороны предназначены для таких событий, как прослушивание сетевых операций — например, когда репозиторий принимает отправку. Клиентские хуки запускаются при действиях, происходящих на компьютере разработчика, например, коммитах и объединении веток.
Полный список хуков есть в документации Git. Я рассмотрю пару из них для начала. Надеюсь, это поможет вам понять, насколько полезны они могут быть в ваших проектах и в рабочем процессе (не автоматизированном).
Хук pre-commit
Клиентский хук запускается до любого другого хука и до коммита любых изменений. Это лучшее место для добавления тестов и прочих проверок вашего кода.
Добавим простой код JavaScript (в котором мы заранее сделали ошибку) в наш небольшой проект:
Мы будем использовать JSHint для выявления ошибок в JavaScript ( инструкция по установке JSHint).
Переименуем файл hooks/pre-commit.sample (этот файл расположен в скрытом каталоге .git вашего проекта) в hooks/pre-commit` и изменим содержимое этого файла на следующее:
Попытаемся сделать коммит изменений:
И получим следующее сообщение об ошибке:
Добавим недостающую точку с запятой и попытаемся еще раз. Коммит пройдет без каких-либо проблем.
Хук post-receive
Этот серверный хук срабатывает после завершения получения переданных изменений в удаленном Git-репозитории. В нашем примере, мы передаем последнюю версию нашего простого сайта в каталог веб-сервера для развертывания.
У меня есть существующий сайт, состоящий из index.html и нескольких страниц еще, которые мы будем использовать в следующих примерах. Вы можете создать свой сайт или использовать пример из демо-репозитория.
Клонируйте репозиторий, используя флаг —bare , чтобы в репозитории была только информация из системы контроля версий, а не наш код:
Теперь создадим хук:
Добавим в файл с хуком следующие строчки:
Примечание: указаны рабочие каталоги в Ubuntu, в вашей системе они могут отличаться.
Эта команда извлекает текущий репозиторий в указанный рабочий каталог, но без данных системы контроля версий.
Нам надо сделать наш хук выполняемым:
На своей локальной машине, клонируйте репозиторий в обычном режиме, используя инструмент по своему выбору и добавьте новый удаленный сервер (не забудьте добавить настройки своего сервера).
Для развертывания на рабочий сервер вместо репозитория введите:
Если вы посмотрите теперь в каталог var/www/html , то вы найдете там автоматически скопированный файл index.html .
Если вы используете свой собственный репозиторий Git, то он расположен на том же сервере, что и ваше приложение и процесс развертывания теперь автоматизирован. Если вы используете Github или иной сторонний сервис Git, этот хук не будет полностью автоматизировать ваш рабочий процесс, а скорее сократит его на один шаг. В дальнейшем мы это упростим.
Один из вариантов это использование команд rsync или scp в хуке post-receive на GitHub. Другой вариант, особенно, если ваше приложение нуждается в процессе сборки перед запуском (Github ограничивает доступные команды) — это использование хука post-receive для запуска скриптов на сервере приложения, проверяющего код на GitHub (с опцией -f ) и запускающему остальные необходимые команды. Как видите, все стало несколько сложнее, нам пора перейти к следующему набору инструментов.
Автоматическое развертывание непосредственно с GitHub
На GitHub есть документация об автоматизации развертывания на платформы интеграции, некоторые из которых также являются хостинг-провайдерами.
Буду честным, большая часть изученной мной документации оказалась некорректной, неточной или бесполезной, поэтому я добавлю ссылки на документацию нескольких популярных хостинг-провайдеров, а для остальных я предлагаю вам использовать post-receive или методы непрерывной интеграции:
Сервисы непрерывной интеграции
Существует множество сервисов, способных отслеживать ваши репозитории на GitHub и не только производить развертывание с них, но и совершать другие действия, такие как запуск тестов и сборка.
Перейдя к новому и более сложному примеру, мы могли бы использовать сервис непрерывной интеграции для автоматизации процесса сборки проекта. В первую очередь после получения ветки Master из репозитория запускается скрипт bash, выполняющий сборку и развертывание, затем генерируется твит об обновлении. Сервис непрерывной интеграции может физически находится на одном сервере с веб-сервисом или на разных, в зависимости от ваших предпочтений.
Рассмотрим самые популярные из них.
Jenkins
Для использования вам надо настроить свой сервер с Jenkins, это даст вам полный контроль над ним, но заставит тратить время на поддержку. К счастью, Jenkins поддерживает многие платформы, в том числе Docker, если вы хотите для начала поэкспериментировать.
Большая часть функциональности Jenkins достигнута за счет плагинов, а благодаря сложившемуся за долгие годы open-source сообществу этих плагинов много. Например, есть плагины для Git, GitHub и Twitter.
Jenkins требует долгой настройки и временами совмещение всех имеющихся инструкций для создания подходящего рабочего процесса требует изучения.
Travis
Инструкции по интеграции с Travis, имеющиеся на GitHub, на данный момент устарели. Но решается это просто: для этого есть документация на сайте Travis.
Travis не требует какой-либо настройки сервера или хостинга, поэтому он подойдет тем, кто не хочет тратить на это время. Тем не менее, расширение его за пределы дефолтных настроек потребует дополнительного конфигурирования. Например, Tweeting требует доступ к веб-хукам.
Travis имеет привычку медленно замечать обновления в ваших репозиториях, особенно если эти изменения произведены в файле настроек самого Travis. Эти проблемы тяжело решить, если у вас нет доступа к серверу Travis.
Другие коммерческие сервисы
Системы интеграции становятся все популярнее, появляется все больше новых сервисов и приложений — многие из них выпущены разработчиками инструментов, которые вы уже используете, и они будут плавно интегрироваться в существующие рабочие цепочки.
Заключение
Надеюсь, это краткое введение разъяснит вам отдельные вопросы, касающиеся работы развертывания. Мы определенно прошли долгий путь со времен отправки файлов на сервер с помощью FTP.
What Is the Easiest Way to Deploy from Github to a Web Server?
![]()
I’ve written before on how to do this the hard way. Now let’s look at the easy way.
I’ll assume you already have a repo setup on Github, and that you are setup to push to it.
Setup on Circleci
I picked circleci but you could re-create this setup with other services such as Codeship, Deployhq, or more.
I like Circleci’s pricing model: it is free. You can pay extra when you want to accelerate your builds — something you may want to do in a company setting.
Create an account
Fairly straight forward. Hit “Sign up” and connect with Github.
Create a project
In the left sidebar, go into “Project”. Then in the upper right corner, click on “Add project”. Find the repository you want to setup.
Once you found it, click “build project”. Let it build. It will tell you at the end that no Circleci setup was found. That’s expected, you’re missing the circle.yml file.
Add a deploy key
You may want to deploy to a simple server like DreamHost, or to an S3 bucket on Amazon. Either way, you’ll need to create a secure access to these places.
Setup ssh keys on your web server (not sure how to do that? Look it up!). And copy your private key.
Next, go into your new project’s settings on circleci. Find the “Permissions” section in the sidebar navigation. Go into the “SSH Permissions” section. Add your private key. This will allow Circleci to deploy to your web server.
How do I pull my project from github?
I have a project on github that I have been working on before. However, I wiped out my computer and I am wondering which git command should I invoke under my username to checkout my project again so that I can push my latest changes to github under my account.
7 Answers 7
Git clone is the command you’re looking for:
It has really useful content
![]()
First, you’ll need to tell git about yourself. Get your username and token together from your settings page.
You will need to generate a new key if you don’t have a back-up of your key.
Then you should be able to run:
![]()
Run these commands:
Since you have wiped out your computer and want to checkout your project again, you could start by doing the below initial settings:
Login to your github account, go to the repository you want to clone, and copy the URL under «Clone with HTTPS».
You can clone the remote repository by using HTTPS, even if you had setup SSH the last time:
If you had setup SSH for your remote repository previously, you will have to add that key to the known hosts ssh file on your PC; if you don’t and try to do git clone git@github.com:username/repo-name.git , you will see an error similar to the one below:
Using HTTPS is a easier than SSH in this case.
You can do it in two ways,
1. Cloning the remote repo to your localhost
2. Pulling the remote repo to your localhost
First, you have to create a local git repo by,
That’s all, All commits and branch in the remote repo now available in your local repository.
Happy Coding, cheers -:)
There are few steps to be followed (For Windows)
Open Git Bash and generate ssh key Paste the text below, substituting in your GitHub email address.
ssh-keygen -t rsa -b 4096 -C «your_email@example.com«
This creates a new ssh key, using the provided email as a label.
Generating public/private rsa key pair.
When you’re prompted to «Enter a file in which to save the key,» press Enter. This accepts the default file location.
Enter a file in which to save the key (/c/Users/you/.ssh/id_rsa):[Press enter]
At the prompt, type a secure passphrase. For more information, see «Working with SSH key passphrases».
Enter passphrase (empty for no passphrase): [Type a passphrase] Enter same passphrase again: [Type passphrase again]
Add the key to SSH Agent
Type the following in Git Bash (99999 is just an example) to see agent is up and running. eval $(ssh-agent -s) Agent pid 99999
then Copy the SSH key to your clipboard using this command
Add the SSH Key to the Git Account
In GitHib site, click on the image on top right corner, and select settings. In the subsequent page, click SSH and GPG keys option. This will open up the SSH key page. Click on the New SSH key. In the «Title» field, add a descriptive label for the new key. Paste your key into the «Key» field.
Простой способ разворачивать (деплоить) проекты на боевом (production) сервере через git
Иногда встречаются заказчики использующие git для хранения своих проектов и, вместе с этим, выгружающие их на боевые серверы через FTP (sFTP). Эта простая инструкция покажет способ разворачивать и обновлять проекты через git.
Для тестирования данного рецепта необходимы базовые навыки работы с git.
Для начала нам нужен основной репозиторий проекта с веткой master. Скорее всего, он у вас уже есть. Если же нет, то создайте его и отправьте в него свой проект. В master-ветке будет происходить разработка. Эта версия проекта (master) будет работать на компьютере разработчика со всеми необходимыми настройками (данными для подключению к БД, логами и т.д.). Чтобы другие разработчики могли участвовать в проекте, выложите master-ветку на один из git-сервисов, например, на github.com, bitbucket.org, свой gitlab-сервер и так далее.
Подготовка боевой версии проекта
Для боевой версии сайта создадим отдельную ветку – “production”. Её мы подготовим для работы с боевым сервером, то есть берем нашу master-ветку и выставляем все необходимые настройки: подключение к БД production-сервера, отключение вывода ошибок, отключения лишнего логирования, деактивация модулей тестирования и так далее. Проще говоря, ветка “production” будет представлять из себя полностью подготовленный проект для работы на боевом сервере. После подготовки выгружаем нашу новую ветку на git-сервер, где уже хранится master-ветка. Именно с этого git-сервера мы будем получать production-ветку для боевого сервера.
Первая выгрузка проекта на боевой сервер
Создаем репозиторий на боевом сервере и закачиваем в него нашу production-ветку. После этого проводим дополнительную настройку, например, обновляем библиотеки composer’a, активируем миграции и так далее. Вот пример того как это можно сделать: