Эта страница была автоматически развёрнута с помощью CI/CD.
Время последнего обновления:
Деплой на GitHub Pages
Обновите ваш файл
.github/workflows/ci.yml:
name: CI/CD for Static Website
on:
push:
branches: [ main ]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./
Этот workflow использует готовый action
peaceiris/actions-gh-pages, который автоматизирует деплой на GitHub Pages.
secrets.GITHUB_TOKEN – это токен, который GitHub автоматически создаёт для каждого workflow, так что вам не нужно настраивать его вручную.
После успешного выполнения workflow:
Перейдите в настройки вашего репозитория (Settings).
Прокрутите вниз до раздела "GitHub Pages".
Убедитесь, что в качестве источника выбрана ветка
gh-pages.
GitHub предоставит URL, по которому доступен ваш сайт (обычно это
https://username.github.io/repository-name/).
Деплой на GitLab Pages
Обновите ваш файл
.gitlab-ci.yml:
stages:
- deploy
pages:
stage: deploy
script:
- mkdir -p public
- cp index.html public/
artifacts:
paths:
- public
only:
- main
Этот pipeline создаёт папку
public (это специальное имя для GitLab Pages) и копирует туда наш HTML-файл. Затем он сохраняет эту папку как артефакт, который GitLab автоматически публикует.
После успешного выполнения pipeline:
Перейдите в "Settings" > "Pages" вашего проекта.
GitLab предоставит URL, по которому доступен ваш сайт (обычно это
https://username.gitlab.io/repository-name/).
Поздравляю! Теперь у вас есть настоящий CI/CD-конвейер, который автоматически публикует ваш сайт при каждом изменении кода. Это уже не просто "Hello, World!" – это полноценный процесс доставки.
Пример: тестовый скрипт
CI – это не только о деплое, но и о проверке качества кода. Давайте добавим простой тест, который будет проверяться автоматически при каждом изменении.
Для JavaScript-проекта
Создайте файл
app.js:
function sum(a, b) {
return a + b;
}
module.exports = { sum };
Создайте файл
test.js:
const { sum } = require('./app');
if (sum(2, 3) !== 5) {
console.error('Test failed: 2 + 3 should equal 5');
process.exit(1);
}
if (sum(-1, 1) !== 0) {
console.error('Test failed: -1 + 1 should equal 0');
process.exit(1);
}
console.log('All tests passed!');
Создайте файл
package.json:
{
"name": "my-first-cicd",
"version": "1.0.0",
"scripts": {
"test": "node test.js"
}
}
Для Python-проекта
Создайте файл
app.py:
def sum(a, b):
return a + b
Создайте файл
test.py:
from app import sum
def test_sum():
assert sum(2, 3) == 5, "2 + 3 should equal 5"
assert sum(-1, 1) == 0, "-1 + 1 should equal 0"
print("All tests passed!")
if __name__ == "__main__":
test_sum()
Обновление GitHub Actions workflow
Обновите ваш файл
.github/workflows/ci.yml для JavaScript:
name: CI/CD for Project
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '16'
- name: Run tests
run: npm test
deploy:
needs: test
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./
Или для Python:
name: CI/CD for Project
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Run tests
run: python test.py
deploy:
needs: test
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./
Обновление GitLab CI pipeline
Обновите ваш файл
.gitlab-ci.yml для JavaScript:
stages:
- test
- deploy
test:
stage: test
image: node:16
script:
- npm test
pages:
stage: deploy
script:
- mkdir -p public
- cp index.html public/
artifacts:
paths:
- public
only:
- main
needs:
- test
Или для Python:
stages:
- test
- deploy
test:
stage: test
image: python:3.10
script:
- python test.py
pages:
stage: deploy
script:
- mkdir -p public
- cp index.html public/
artifacts:
paths:
- public
only:
- main
needs:
- test
Теперь наш CI/CD-процесс стал ещё более полноценным:
При каждом изменении кода автоматически запускаются тесты.
Если тесты проходят успешно, код автоматически публикуется.
Если тесты не проходят, деплой не выполняется – это защищает нас от публикации сломанного кода.
Это базовый, но уже вполне рабочий CI/CD-конвейер. В реальных проектах тесты будут более сложными, но принцип остаётся тем же: автоматическая проверка → автоматический деплой.
Полезные советы и выводы
Теперь, когда у вас есть работающие CI/CD-конфигурации, вот несколько полезных советов:
1. Проверяйте статус
После каждого пуша убедитесь, что ваш workflow или pipeline действительно запускается:
На GitHub: вкладка "Actions"
На GitLab: "CI/CD" > "Pipelines"
Зелёный статус означает, что всё прошло успешно. Красный – что-то пошло не так.
2. Читайте логи
Если что-то не работает, логи – ваш лучший друг. Они покажут, на каком именно шаге произошла ошибка и что пошло не так. Кликните на job, чтобы увидеть подробный вывод каждой команды.
3. Быстро правьте
Одно из преимуществ CI/CD – быстрая обратная связь. Если вы видите ошибку, исправьте её и снова отправьте изменения. Через несколько минут вы узнаете, помогло ли исправление.
4. Экспериментируйте
Не бойтесь экспериментировать! Специально сломайте тест, чтобы увидеть, как система отреагирует. Добавьте новые шаги в workflow. Чем больше вы экспериментируете, тем лучше понимаете, как всё работает.
5. Используйте готовые actions и templates
И GitHub, и GitLab предлагают множество готовых actions и templates для типичных задач. Не изобретайте велосипед – ищите готовые решения в маркетплейсе GitHub Actions или в документации GitLab CI.
6. Постепенно усложняйте
Начните с простого, как мы сделали в этой статье, и постепенно добавляйте новые возможности: больше тестов, статический анализ кода, автоматическую сборку более сложных приложений.
Поздравляю, вы только что построили конвейер! Ну почти, но уже уверенно движетесь в правильном направлении. Теперь у вас есть автоматизированный процесс, который проверяет и публикует ваш код без ручного вмешательства. Это уже настоящий DevOps!
Терминология
В мире CI/CD используется множество специфических терминов. Вот краткий словарик, который поможет вам лучше понимать документацию и обсуждения:
Workflow – сценарий автоматизации, описанный в YAML-файле на GitHub Actions.
Job – отдельная задача в workflow или pipeline, которая выполняется на одном runner-е.
Runner – виртуальная машина или контейнер, на котором исполняются задачи.
Step – отдельный шаг внутри job-а, например, команда или action.
YAML – формат файла, используемый для описания workflow и pipeline. Отступы в нём критически важны!
Script – раздел с командами в GitLab CI-файле.
Action – готовое действие на GitHub, которое можно использовать в своих workflow, например,
actions/checkout.
Stage – этап pipeline в GitLab, например, build, test, deploy.
Artifact – файл или набор файлов, созданный во время выполнения job-а и сохранённый для использования в других job-ах или для скачивания.
Environment – среда, в которую выполняется деплой, например, staging или production.
Не переживайте, если сразу не запомните все термины – они станут понятнее по мере практики.
Итоги
В этой статье мы:
Создали репозитории на GitHub и GitLab.
Настроили первые workflow и pipeline.
Автоматизировали деплой статического сайта.
Добавили автоматические тесты.
Построили полноценный CI/CD-конвейер, который проверяет и публикует код при каждом изменении.
Теперь при каждом пуше в ветку
main автоматически выполняются тесты, и если они проходят успешно, сайт обновляется. Команде больше не нужно вручную запускать проверку – теперь ошибки видны сразу, а деплой происходит автоматически.
Это только начало вашего путешествия в мир CI/CD. В следующей статье мы рассмотрим более сложные сценарии: работу с разными ветками, условное выполнение шагов, использование секретов для безопасного хранения чувствительных данных и лучшие практики настройки CI/CD для реальных проектов.
А пока – экспериментируйте с тем, что вы узнали сегодня. Добавьте больше тестов, попробуйте другие actions, настройте деплой для своего проекта. Практика – лучший способ закрепить знания.