Перейти к содержанию

Взаимодействие с GitHub

Взаимодействие с GitHub

Wisebot использует Git для управления версиями.

Каждый проект можно подключить к ветке репозитория GitHub, что позволяет отправлять изменения и возвращаться к предыдущим версиям.

Содержание инструкции:

Установка Git

  • Windows: Скачайте Git для Windows и следуйте инструкциям установки.
  • macOS: Скачайте Git для macOS и запустите установщик.
  • Linux: Установите Git через менеджер пакетов, например:
sudo apt-get install git

Настройка Git

Настройте имя пользователя и электронную почту:

git config --global user.name "Ваше Имя"
git config --global user.email email@example.com

Регистрация на GitHub

  1. Перейдите на https://github.com и нажмите Sign up.
  2. Введите имя пользователя, адрес электронной почты и пароль.
  3. Подтвердите почту с помощью кода активации.
  4. Следуйте инструкциям по выбору тарифного плана и настройке профиля.

Создание Репозитория

  1. Нажмите Create repository.
  2. Введите название репозитория.
  3. Нажмите Create repository.

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

Используйте SSH-ключи для аутентификации и настройте доступ с минимальными необходимыми разрешениями.

  • Проверка установки Git:
git --version

Должен отобразиться номер версии, например, git version 2.35.1.

  • Добавление SSH-ключа:

Сгенерируйте SSH-ключ и добавьте его в ваш аккаунт GitHub:

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

Затем добавьте содержимое ~/.ssh/id_rsa.pub в разделе SSH-ключей вашего профиля GitHub.

Теперь ваш проект Wisebot может быть связан с репозиторием GitHub для управления версиями и совместной работы.

Преобразователь формата данных

Markdown — это, пожалуй, самый безопасный выбор для начинающих при создании данных. Однако может возникнуть ситуация, когда обучающие данные автоматизированы или получены из другого источника, такого как формат данных LUIS, формат данных WIT, формат данных Dialogflow или JSON. Rasa предоставляет способ преобразования формата данных. Убедитесь, что виртуальная среда активирована, и выполните следующую команду (она преобразует MD в JSON):

rasa data convert nlu --data data/nlu.md --out data/nlu.json -f json
  1. --data — путь к файлу или каталогу, содержащему данные Rasa NLU.
  2. --out — имя файла для сохранения тренировочных данных в формате Rasa.
  3. -f — выходной формат, в который должны быть преобразованы данные обучения. Принимает либо json, либо md.

После получения необходимых данных переместите их в папку data и удалите все существующие файлы.

Взаимодействие с GitHub

Управление версиями в Wisebot осуществляется с помощью Git. Каждый проект может быть подключен к ветке репозитория Git, что позволяет отправлять изменения и возвращаться к предыдущим версиям.

Установка Git

Windows:
Скачайте Git для Windows, запустите .exe-файл и следуйте инструкциям установщика.

macOS:
Скачайте Git для macOS и запустите .dmg-файл. Если установка не начинается, перейдите в Системные настройки → Безопасность и нажмите кнопку Open anyway (Открыть всё равно).

Linux:
Установите Git через встроенный менеджер пакетов. Для Ubuntu используйте команду:

sudo apt-get install git

Команды для других дистрибутивов можно найти здесь.

Проверка установки Git

Откройте терминал и введите команду:

git --version

Если Git установлен, вы увидите номер версии, например, git version 2.35.1.

Настройка Git

Выполните следующие команды для настройки имени пользователя и электронной почты, чтобы ваши действия в Git были подписаны и связаны с GitHub:

Добавить имя (введите его в кавычках):

git config --global user.name "ваше имя"

Добавить электронную почту (замените email@example.com на вашу почту):

git config --global user.email email@example.com

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

Регистрация на GitHub

GitHub — веб-сервис на основе Git, который помогает совместно разрабатывать IT-проекты. На GitHub разработчики публикуют свой и редактируют чужой код, комментируют проекты и следят за обновлениями других пользователей.

Ваш профиль на GitHub и все проекты в нём — это публичное портфолио разработчика, поэтому необходимо создать профиль, если у вас его ещё нет.

  1. Перейдите на https://github.com и нажмите кнопку Sign up.
  2. Введите имя пользователя (понадобится в дальнейшей работе), адрес электронной почты (тот же, что использовался при настройке Git) и пароль.
  3. На вашу почту придёт код активации — введите его на сайте.
  4. Выберите тарифный план. Если вы пользуетесь GitHub для учёбы, укажите, что профиль нужен только для вас и вы студент.
  5. Пропустите опросы и выбор интересов.

Поздравляем! Вы зарегистрировались, и у вас есть собственный профиль.

Создание репозитория

  1. Нажмите на кнопку Create repository (Создать репозиторий).

Создание репозитория

  1. Введите название репозитория в поле Repository name (Название репозитория).

Название репозитория

  1. Нажмите кнопку Create repository (Создать репозиторий).

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

Два ключевых компонента для подключения к репозиторию Git — строка подключения и аутентификация. Существует множество методов аутентификации для Git, но рекомендуется использовать SSH-ключи, поскольку они обеспечивают более высокий уровень безопасности. Также следует ограничить доступ к ключу минимальными необходимыми разрешениями для извлечения и отправки в используемую ветку проекта.

Обратите внимание, что SSH-ключи, хранящиеся в Wisebot, не шифруются и видны любому пользователю с разрешением git-credentials:r в области проекта.

Установка SSH-ключей

Для доступа к проектам на GitHub со своего компьютера и выполнения команд без постоянного ввода пароля необходимо использовать SSH-ключи.

SSH — протокол для безопасного соединения между компьютерами.

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

Подключение к GitHub через SSH работает следующим образом:

  1. Вы отправляете запрос к GitHub, который знает ваш открытый ключ.
  2. GitHub подтверждает вашу личность и отправляет ответ.
  3. Только вы можете расшифровать этот ответ, поскольку только у вас есть соответствующий закрытый ключ.
Создание SSH-ключа

Для создания SSH-ключа в Linux/macOS откройте терминал и введите команду:

ssh-keygen -C "your_email@example.com"

При появлении запроса укажите имя файла и нажмите клавишу Enter.

Создание SSH-ключа

Затем введите и повторно подтвердите парольную фразу.

Парольная фраза

После этого будет создан SSH-ключ. Полный вывод терминала должен выглядеть примерно так:

SSH-ключ создан

В каталоге, где вы создавали ключи, появятся два файла: id_rsa (закрытый ключ) и id_rsa.pub (открытый ключ).

Файлы SSH-ключей

Добавление SSH-ключа в репозиторий GitHub
  1. Откройте репозиторий GitHub.
  2. Перейдите в Settings (Настройки) → Deploy keys (Развертывание ключей).
  3. Нажмите Add deploy key (Добавить ключ развертывания).
  4. Введите заголовок и вставьте содержимое файла .pub в поле Key (Ключ).
  5. Установите флажок Allow write access (Разрешить доступ на запись), чтобы Wisebot мог отправлять данные.
  6. Нажмите Add key (Добавить ключ).

Добавление SSH-ключа

Теперь вы увидите новый ключ с указанным заголовком в разделе Deploy keys.

Подключение Wisebot к Git

  1. Откройте проект в Wisebot и перейдите в Settings (Настройки) → Git credentials (Учетные данные Git).
  2. Скопируйте строку подключения Git в поле репозитория и укажите имя ветки, которую Wisebot будет использовать для хранения текущего проекта.

Примечание: Ключ SSH состоит из двух файлов: открытого ключа (.pub) и закрытого ключа. Скопируйте содержимое *.pub в поле для открытого ключа, а закрытый ключ вставьте в соответствующее поле.

  1. Нажмите кнопку Save (Сохранить), чтобы сохранить учетные данные. После сохранения интерфейс будет выглядеть следующим образом:

Сохраненные учетные данные

  1. Чтобы убедиться, что вы подключены к Git, вернитесь на экран историй и убедитесь, что кнопка Git видна на верхней панели.

Кнопка Git

Примечание: Кнопка Git будет отключена, если проект не подключен к экземпляру Rasa, так как обработка импортированных и экспортированных файлов зависит от Rasa.

Использование интеграции Git

После подключения проекта к репозиторию Git кнопка Git появится на главной панели. Нажмите на неё, чтобы открыть выпадающий список с двумя действиями: Commit & Push (Фиксация и отправка) и Revert (Возврат к предыдущему).

Фиксация и отправка

Чтобы сохранить изменения в подключенном репозитории:

  1. Выберите опцию Commit & Push в выпадающем списке Git.
  2. В открывшемся окне введите сообщение фиксации, описывающее внесённые изменения.
  3. Нажмите кнопку Push to Remote (Отправить на удалённый сервер), чтобы сохранить изменения.

Если изменения успешно сохранены, в правом верхнем углу экрана появится зелёное уведомление.

Успешная отправка

Если с момента последней фиксации не было изменений, появится жёлтое уведомление.

Нет изменений

Если Wisebot не может выполнить фиксацию и отправку, возникнет красное уведомление с сообщением об ошибке.

Ошибка отправки

Возврат к предыдущей версии

Чтобы вернуться к предыдущей версии проекта:

  1. Выберите опцию Revert в выпадающем списке Git.
  2. В открывшемся окне найдите фиксацию, к которой хотите вернуться, наведите курсор на строку и нажмите появившуюся кнопку Revert (Возвратиться).
  3. Если в проекте есть несохранённые изменения, они будут сохранены с сообщением фиксации перед возвратом к выбранной версии.

Примечание: Project state before revert to <commitId>