Настоящий workflow

Скопировать кодYAML
name: Flask-app workflow

on: [push]

jobs:
  tests:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python 
      uses: actions/setup-python@v2
      with:
        python-version: 3.8

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8 pytest
        pip install -r requirements.txt

    - name: Lint with flake8
      run: flake8 .

    - name: Test with pytest
      run: pytest tests.py 

Скопировать кодYAML
run: |
  команда1
  команда2
  команда3 

Тесты для flask-проекта

Скопировать кодPYTHON
import unittest
import hello as tested_app


class FlaskAppTests(unittest.TestCase):
    def setUp(self):
        tested_app.app.config['TESTING'] = True
        self.app = tested_app.app.test_client()

    def test_get(self):
        r = self.app.get('/')
        self.assertEqual(r.data.decode('utf-8'), 'У меня получилось!')

    def test_post(self):
        r = self.app.post('/')
        self.assertEqual(r.status_code, 405)


if __name__ == '__main__':
    unittest.main()
 

Скопировать кодPYTHON

FROM python:3.8-alpine
COPY ./ /app
RUN pip install -r /app/requirements.txt
EXPOSE 5000
CMD python /app/hello.py 

Скопировать кодPYTHON
docker run -p 5000:5000 <CONTAINER ID> 

Автоматическая сборка и пуш docker-образа

Скопировать кодYAML
name: CI

on:
  push:
    branches: [ main ]
    ...

jobs:
  tests:
    runs-on: ubuntu-latest
    steps:
    - ...

  build:
    runs-on: ubuntu-latest
    needs: tests # не запускать сразу, ждать, пока выполнится tests
    steps:
    - ...

  deploy:
    runs-on: ubuntu-latest
    needs: build # не запускать сразу, ждать, пока выполнится build
    steps:
    - ... 

Скопировать кодYAML

  build_and_push_to_docker_hub:
    name: Push Docker image to Docker Hub
    runs-on: ubuntu-latest
    needs: tests
    steps:
      - name: Check out the repo
        uses: actions/checkout@v2
      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v1
      - name: Login to Docker
        uses: docker/login-action@v1
        with:
          username: ${{ secrets.DOCKER_USERNAME }}
          password: ${{ secrets.DOCKER_PASSWORD }}
      - name: Push to Docker Hub
        uses: docker/build-push-action@v2
        with:
          push: true
          tags: <логин-на-docker-hub>/<репозиторий-на-docker-hub>:latest 

Как хранить секреты в GitHub Actions

1. Перейдите в настройки репозитория Settings, выберите на панели слева Secrets, нажмите New secret:

2. Задайте имя секрета и его значение и нажмите Add secret. Сохраните переменные DOCKER_USERNAME и DOCKER_PASSWORD с необходимыми значениями.

• Названия могут содержать цифры и символы английского алфавита в любом регистре, а также символ нижнего подчеркивания. Рекомендуется использовать символы верхнего регистра, как для констант.
• Названия не могут начинаться с цифры и с префикса GITHUB_

Deploy

1. Скопируйте приватный ключ со своего сервера в Яндекс.Облаке:

   Скопировать кодPYTHON
    cat ~/.ssh/id_rsa
     

2. На GitHub Actions сохраните ключ в Secrets в переменную SSH_KEY.
3. На GitHub Actions сохраните ещё две переменные:
   • в переменной USER сохраните имя пользователя для подключения к серверу
   • в переменной HOST сохраните IP-адрес вашего сервера. Если при создании ssh-ключа вы использовали фразу-пароль, то добавьте также переменную PASSPHRASE.
4. Добавьте ещё один job в workflow:

   Скопировать кодYAML
    deploy:
      runs-on: ubuntu-latest
      needs: build_and_push_to_docker_hub
      steps:
      - name: executing remote ssh commands to deploy
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.HOST }}
          username: ${{ secrets.USER }}
          key: ${{ secrets.SSH_KEY }}
          passphrase: ${{ secrets.PASSPHRASE }} # если ваш ssh-ключ защищен фразой-паролем
                    source: "docker-compose.yaml, nginx/default.conf"
          target: "~/app/"
          script: |
            sudo docker pull <имя-пользователя>/<имя-репозитория>
            sudo docker stop $(sudo docker ps -a -q)
            sudo docker run --rm -d -p 5000:5000 <имя-пользователя>/<имя-репозитория>
     

Отправка отчета

Скопировать кодYAML
send_message:
  runs-on: ubuntu-latest
  needs: deploy
  steps:
  - name: send message
    uses: appleboy/telegram-action@master
    with:
      to: ${{ secrets.TELEGRAM_TO }}
      token: ${{ secrets.TELEGRAM_TOKEN }}
      message: ${{ github.workflow }} успешно выполнен! 

• чтобы бот отправил сообщение именно вам — в переменную TELEGRAM_TO добавьте ID своего телеграм-аккаунта. Узнать свой ID можно у бота @userinfobot.
• в переменную TELEGRAM_TOKEN добавьте токен вашего бота. Получить этот токен можно у бота @BotFather.

1. Тестирование проекта
2. Сборка и публикация образа
3. Автоматический деплой
4. Отправка уведомления в персональный чат